Pular para o conteúdo principal

Referência de Erros

Formato padrão de erro

Todos os erros de autenticação retornam o seguinte envelope JSON:

{
"Error": "invalid_client",
"ErrorDescription": "Invalid API key."
}
CampoDescrição
ErrorCódigo do erro
ErrorDescriptionMensagem descritiva

Tabela de erros

StatusErrorCausaEndpoint
401invalid_clientAPI key ausente ou inválidaPOST /token
401invalid_grantRefresh token inválido, expirado ou já utilizadoPOST /refresh
401invalid_grantBody inválido (campo ausente)POST /refresh
401JWT ausente, expirado ou inválidoQualquer rota protegida
403JWT válido, mas sem permissão para o endpointGET /orders
204Sucesso sem bodyPOST /revoke

Fluxo de tratamento recomendado

Resposta da API

├── 200 → sucesso, processar resposta

├── 401 com Error: "invalid_grant"
│ └── tentar /refresh
│ ├── 200 → novo par de tokens, repetir chamada
│ └── 401 → sessão expirada, usar API key em /token

├── 401 (sem body de error) → JWT expirado
│ └── usar /refresh para renovar

├── 403 → sem permissão para o endpoint
│ └── contatar o time IFW para ajustar permissões

└── 5xx → erro no servidor, aguardar e tentar novamente (backoff exponencial)