Pular para o conteúdo principal
​
ConsultasDocumentação
Data do deploy: pendente

​
Nova consulta: licenciamento (CRLV)

POST /api/v1/consultas/placa-crlv devolve a data do último licenciamento do veículo (emissão do CRLV) pela placa. Responde só plate, chassis e licensingDate; sem a data, responde 404. Escopo próprio, consultas.placa-crlv:execute. Vale também no legado.

​
Portal do desenvolvedor

A documentação passa a ser este portal, no mesmo endereço (/api/reference): guias, catálogo de produtos, changelog e a referência da v1 e do legado. O header Link de depreciação do legado aponta para o guia de migração.
​
VersionamentoErrosLimitesCalculadoras
Data do deploy: pendente

​
v1 publicada

A v1 está em /api/v1. As rotas sem versão (/api/...) passam a ser o legado, com referência própria. Elas continuam funcionando; a depreciação, quando houver, entra neste changelog com as datas. Veja a migração do legado.
  • POST /api/calculadoras/correction_simple passa a ser POST /api/v1/calculadoras/correcao-simples. Payload e resposta não mudam.
  • JusScore: url_retorno indisponível na v1 até o webhook assinado entrar; enviá-lo responde 400.

​
Erros

  • Todo erro traz o campo code (catálogo). Vale também no legado, onde é um campo novo e não quebra quem já integra.
  • Todo erro traz requestId, e toda resposta o header X-Request-Id, para rastrear a chamada com o suporte. Vale também no legado.
  • Corpo acima do limite passa a responder 413 payload_too_large; antes respondia 500.

​
Acesso e limites

  • Autorização por escopo: cada chave só acessa os produtos liberados para ela; fora deles, 403 com code: insufficient_scope. Vale também no legado.
  • Limite de requisições por minuto, por cliente e produto: 429 com Retry-After acima do limite e headers X-RateLimit-* nas respostas das rotas de negócio.
  • O 429 de consultas assíncronas pendentes (too_many_pending_queries) também traz Retry-After, como estimativa. Vale também no legado.
  • GET /api/v1/consumo: o consumo da própria chave num período, por produto, separando cobradas e não cobradas. Só na v1.

​
Calculadoras

  • Relatório PDF da calculadora completa: POST /api/v1/calculadoras/completa/relatorio (mesmo payload da completa, 202 com o id), GET .../relatorio/{id} para a situação e GET .../relatorio/{id}/pdf para o arquivo. Escopo próprio, calculadoras.completa-relatorio:execute. Só na v1.
  • Calculadora completa: cada bloco de juros aceita tipo_taxa (PERCENTUAL, padrão, SELIC, POUPANCA ou TAXA_LEGAL) e regime. É assim que a SELIC entra como juros, somada ou capitalizada; sem os campos, o cálculo não muda. Vale também no legado.