Guias
Erros
Códigos HTTP, formato do corpo e limites de taxa.
Erros de protocolo usam o formato do Django REST framework. Mensagens de validação voltam em português.
400Campo inválido. A chave é o nome do campo.401API key ausente ou revogada.404O recurso não está nesta conta.409O estado não permite a operação.422O provedor externo falhou.429Limite de taxa. Espere e tente de novo.
HTTP
| Código | Quando |
|---|---|
400 |
Corpo inválido. A chave é o nome do campo |
401 |
API key ausente, inválida ou revogada |
404 |
Recurso inexistente nesta conta, por exemplo veículo ou consulta |
409 |
Conflito de estado, por exemplo pagar um pedido que não é cartão |
422 |
Falha numa integração externa |
429 |
Limite de taxa |
Validação:
{ "plate": ["Placa inválida."] }
Conflito, autenticação ou recurso ausente:
{ "detail": "Veículo não encontrado." }
Limites atuais
| Escopo | Taxa |
|---|---|
| Criar consulta | 20 por hora |
| Criar pedido ou pagar cartão | 30 por hora |
| Rotas de autenticação de usuário | 30 por hora |
O limite pode ser ajustado no servidor. Trate 429 com retry e backoff, e não reabra consulta em loop apertado: faça polling do recurso que já existe.
Consulta que falhou
status: "failed" é uma resposta 200. O erro de negócio está em error_code, error_title e error_action, não no HTTP. Mostre error_title ao operador e use error_action como próximo passo.
Placa e documento
- Placa: Mercosul ou padrão antigo, três letras, um dígito, uma letra ou dígito e dois dígitos. Hífen é removido.
- Renavam: 9 a 11 dígitos. A API completa com zeros à esquerda até 11.
owner_document: 11 dígitos (CPF) ou 14 (CNPJ).