Erros e códigos de status
O que cada código HTTP significa e como tratar.
Erros sempre vêm com um message legível. Alguns trazem também um code para tratamento automático.
JSON
{
"message": "Para usar a consulta \"Mandados de Prisão\", aceite o termo de finalidade.",
"code": "PURPOSE_NOT_ACCEPTED"
}| HTTP | Quando acontece | Como tratar |
|---|---|---|
400 | Documento, CNJ, placa ou parâmetro inválido | Corrija a entrada; nada foi cobrado |
401 | Chave ausente, inválida ou revogada | Confira o cabeçalho Authorization |
402 | Saldo insuficiente ou consulta não habilitada no seu plano | Adicione saldo ou contrate um plano |
403 | Termo de finalidade pendente, documento com restrição de privacidade ou requestId de outra conta | Veja o code e a mensagem |
404 | requestId não encontrado | Confira o ID retornado na criação |
409 | Operação em conflito (ex.: atualização já em andamento) | Aguarde e tente de novo |
429 | Muitas requisições em pouco tempo | Espere alguns segundos e reduza o ritmo |
500 | Erro inesperado do nosso lado | Tente de novo; se persistir, fale com o suporte |
Códigos (code)
| Código | Significado |
|---|---|
PURPOSE_NOT_ACCEPTED | A consulta exige o termo de finalidade aceito no painel |
INSUFFICIENT_BALANCE | Saldo insuficiente para a consulta |
Restrição de privacidade
Titulares podem pedir a restrição dos próprios dados. Nesses casos a consulta é recusada e nada é cobrado.