Referência da API

Convenções

Versão, paginação, dinheiro, identificadores e headers comuns.

A referência descreve o contrato HTTP que uma empresa integradora usa. A spec OpenAPI inicial está em openapi/openapi.yaml, na raiz deste repositório.

CadastroVeículos

Criar, listar, ler e desativar. A listagem traz o resumo da última consulta.

DébitosConsultas

Disparar, ler e pegar a última. O item pagável vira o id do pedido.

CobrançaPedidos

Criar, ler, reapresentar Pix e pagar no cartão.

Versão

O prefixo é /api/v1. Uma mudança incompatível ganha outro prefixo. Campos novos em respostas existentes entram nesta versão.

Headers

Header	Onde
`X-Api-Key`	Rotas autenticadas
`X-Account-Id`	Veículos, consultas e pedidos
`Content-Type: application/json`	Corpos JSON
`Accept: application/json`	Opcional; a API já responde JSON

Listas

GET de coleção usa paginação por página.

Query	Padrão	Teto
`page`	1	—
`page_size`	20	100

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": []
}

Tipos

Identificadores são UUID.
Dinheiro é string decimal com duas casas, por exemplo "129.90".
Datas são ISO 8601, no fuso da API (America/Sao_Paulo nos timestamps gerados pelo servidor).
Placa volta normalizada, sem hífen, em maiúsculas.

O que esta referência ainda não cobre

Portal do parceiro (marcas, hosts, membros, chaves), alertas, CRLV, cotações e templates de e-mail existem na API e entram na spec completa. O marco 3 em MILESTONES.md descreve esse fechamento. Enquanto isso, o fluxo de consulta e cobrança desta seção é o contrato para integrar.

Para chamar as rotas abaixo no browser, use o sandbox.