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ódigo | Nome | Descrição |
|---|---|---|
| 200 | OK | Requisição executada com sucesso. |
| 201 | Created | Recurso criado com sucesso. |
| 400 | Bad Request | Parâmetros inválidos ou corpo malformado. |
| 401 | Unauthorized | Token ausente, inválido ou expirado. |
| 403 | Forbidden | Token válido mas sem permissão. |
| 404 | Not Found | Recurso não encontrado. |
| 422 | Unprocessable Entity | Validação de regra de negócio falhou. |
| 429 | Too Many Requests | Limite de requisições atingido. |
| 500 | Internal Server Error | Erro inesperado no servidor. |
Boas práticas
- Implemente retry com backoff exponencial em
429e5xx. - Em
401, regenere o token automaticamente antes de tentar novamente. - Logue o
codeemessageretornados para facilitar suporte.
