Skip to main content

​
Erros e Códigos

A API utiliza códigos de status HTTP padrão e retorna mensagens de erro estruturadas para facilitar o diagnóstico e tratamento de problemas.

​
Formato de Erro

{
  "status": "error",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "O campo 'name' é obrigatório.",
    "details": [
      {
        "field": "name",
        "message": "Este campo não pode ser vazio."
      }
    ]
  },
  "meta": {
    "request_id": "req-uuid",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}

​
Códigos de Status HTTP

CódigoSignificadoUso
200OKRequisição bem-sucedida
201CreatedRecurso criado com sucesso
204No ContentOperação bem-sucedida sem conteúdo de retorno
400Bad RequestDados inválidos ou malformados
401UnauthorizedToken ausente ou inválido
403ForbiddenSem permissão para acessar o recurso
404Not FoundRecurso não encontrado
409ConflictConflito (ex: registro duplicado)
422Unprocessable EntityErro de validação nos dados enviados
429Too Many RequestsLimite de requisições excedido
500Internal Server ErrorErro interno do servidor

​
Códigos de Erro Internos

CódigoDescrição
VALIDATION_ERRORErro de validação nos dados enviados
AUTHENTICATION_ERRORFalha na autenticação
AUTHORIZATION_ERRORSem permissão para a operação
RESOURCE_NOT_FOUNDRecurso solicitado não existe
DUPLICATE_RESOURCETentativa de criar recurso duplicado
RATE_LIMIT_EXCEEDEDLimite de requisições excedido
INTERNAL_ERRORErro interno não especificado