Começar
Visão geral
O que a API cobre, para quem ela serve e como uma integração começa.
A API v1 é o caminho para uma empresa operar débitos veiculares dentro do próprio produto. O integrador autentica a marca, escolhe a conta do cliente final e conduz três recursos: veículo, consulta e pedido.
Placa, Renavam, UF e documento do proprietário. O id segue para a consulta.
Nasce pending. Em ready, cada débito pagável tem um id.
Soma os débitos e a taxa. Pix, boleto ou cartão, e a liquidação no DETRAN.
O que a integração faz
- Cadastra o veículo com placa, Renavam, UF e documento do proprietário.
- Consulta débitos (IPVA, licenciamento, multas e outros itens retornados pelo órgão).
- Abre um pedido com os itens escolhidos, em Pix, boleto ou cartão.
- Acompanha o pagamento e a liquidação. Quando o status do pedido muda, a Zera pode avisar o seu sistema por webhook.
A consulta e a cobrança passam pelos provedores da Zera (Banco do Brasil e o adquirente de pagamento). O contrato abaixo é o da API Zera, não o desses provedores.
Base URL
| Ambiente | Base |
|---|---|
| Produção | https://api.zera.mobi |
| Develop | https://dev-api.zera.mobi |
Os recursos de negócio usam o prefixo /api/v1. O health check fica em GET /health, fora desse prefixo.
O que você precisa antes da primeira chamada
- Uma API key da marca, criada no portal do parceiro. O segredo aparece uma vez.
- O UUID da conta em que o veículo será lançado (
X-Account-Id). - Placa, Renavam, UF e CPF ou CNPJ do proprietário.