Guia

Erros

Erros seguem códigos HTTP padrão e um corpo JSON com detalhes para depuração.

Formato de erro

Exemplo
{
  "code": "INVALID_TOKEN",
  "message": "O token informado expirou.",
  "details": {}
}

Códigos HTTP

CódigoNomeDescrição
200OKRequisição executada com sucesso.
201CreatedRecurso criado com sucesso.
400Bad RequestParâmetros inválidos ou corpo malformado.
401UnauthorizedToken ausente, inválido ou expirado.
403ForbiddenToken válido mas sem permissão.
404Not FoundRecurso não encontrado.
422Unprocessable EntityValidação de regra de negócio falhou.
429Too Many RequestsLimite de requisições atingido.
500Internal Server ErrorErro inesperado no servidor.

Boas práticas

  • Implemente retry com backoff exponencial em 429 e 5xx.
  • Em 401, regenere o token automaticamente antes de tentar novamente.
  • Logue o code e message retornados para facilitar suporte.