Erros seguem um formato JSON consistente:{
"statusCode": 400,
"message": "Descricao do problema",
"error": "Bad Request"
}
Em casos de validacao que falham em multiplos campos, message vira um array:{
"statusCode": 422,
"message": [
"email must be an email",
"name should not be empty"
],
"error": "Unprocessable Entity"
}
Codigos HTTP#
| Codigo | Significado | O que fazer |
|---|
| 400 | Payload invalido | Revise o corpo da requisicao |
| 401 | Chave ausente ou invalida | Cheque o header Authorization |
| 403 | Sem permissao | A chave existe mas nao tem escopo pra esse recurso |
| 404 | Recurso nao encontrado | ID errado ou entidade foi removida |
| 422 | Validacao falhou | Cheque o array message pra saber quais campos |
| 429 | Limite de taxa excedido | Espere Retry-After segundos |
| 500 | Erro interno | Tente novamente; se persistir, reporte no suporte |
Idempotencia#
Requisicoes POST, PATCH e DELETE podem ser re-enviadas com seguranca se a resposta anterior nao chegou (timeout, 5xx). Use o mesmo payload — o sistema detecta duplicatas pelos IDs de associacao.Contato#
O statusCode e message da resposta
O X-Request-Id do header (quando presente)
O endpoint e metodo chamados
O payload enviado (sem chaves de API)
Modified at 2026-04-18 19:47:50