FAQ e suporte
Perguntas frequentes, como pedir ajuda, confiabilidade e contato comercial para integradores.
Perguntas frequentes
Como consigo uma chave de API?
O titular da conta ou um administrador gera a chave em Conta › Integrações no Portal do Cliente, na hora e sem pedido de liberação. Há uma chave de produção (
zc_live_) e uma de teste (zc_test_) por conta. Ver Autenticação.Dá para testar sem gastar saldo?
Sim. A chave
zc_test_ usa a mesma URL e os mesmos endpoints, não cobra e escolhe o desfecho pela placa. Ver Sandbox e o API Explorer.Como a API é cobrada?
Pelo saldo da carteira, pré-pago. Cada consulta debita o valor do catálogo da API no momento da criação; consulta que falha é estornada automaticamente. Ler resultado e baixar documento não custam nada. Ver Cobrança e estorno.
O preço da API é o mesmo do portal?
Nem sempre: os valores da API seguem o catálogo de integrações. A Tabela FIPE, por exemplo, é gratuita no portal e cobrada por requisição na API. O preço que vale para a sua conta vem em
GET /v1/servicos.Posso chamar a API direto do navegador ou de um app?
Não. A chave de produção dá acesso ao saldo da conta: a chamada precisa sair do seu servidor. O API Explorer desta documentação aceita só a chave de teste, justamente por isso.
De onde vêm os dados?
Os dados são fornecidos por provedores especializados que consultam bases oficiais e fontes veiculares. A disponibilidade das informações pode variar conforme a placa, UF, fonte consultada e atualização das bases.
Quanto tempo leva uma consulta?
A maioria conclui em poucos minutos. A base estadual pode levar cerca de 2 minutos numa placa consultada pela primeira vez no dia; emissões de CRLV em alguns estados e a 2ª via do ATPV-e podem levar mais. Use polling com teto de 5 minutos ou webhook.
Os relatórios podem sair com a minha marca?
Sim, nos relatórios compatíveis: cadastre a logo em Conta › Empresa, no Portal do Cliente. Documentos oficiais, como CRLV, ATPV-e e Código de Segurança, permanecem inalterados, exatamente como o órgão emissor os entrega.
Qual o limite de requisições?
120 por minuto em produção e 60 no sandbox, por conta e por IP. Para volume maior, fale com a equipe comercial antes de subir a carga. Ver Limites.
Existe SLA contratual?
Não publicamos SLA, uptime ou prazo garantido: a API depende de bases externas cuja disponibilidade não controlamos. O que publicamos é o estado verificado na página de status, o catálogo de erros com
retryable e o estorno automático de toda consulta que falha.Onde vejo o consumo da integração?
No Portal do Cliente, em Conta › Integrações, aba Consumo (por chave), e no extrato da carteira (débitos e estornos).
Como sei que algo mudou na API?
No changelog. Mudança que pode exigir ajuste de quem já integra vem marcada como Atenção.
Suporte técnico
Plataforma disponível 24h, todos os dias. Atendimento humano por e-mail, de segunda a sexta, das 8h às 18h. As mensagens são respondidas por e-mail dentro do horário de atendimento.
| Canal | Como |
|---|---|
| suporte@zapcarconsulta.com.br | |
| Central de ajuda | Formulário no site, com resposta por e-mail |
| Suporte no Portal do Cliente | Conversa com a equipe dentro do painel, para quem já tem conta |
| Integração e homologação | API e integrações: Homologação, chaves de API, ambiente de teste e webhooks. |
Informação:
Para uma resposta mais rápida
Envie o
request_id da resposta (ou o id da consulta), o endpoint, o horário aproximado e o que você esperava. Nunca envie a chave de API nem o secret do webhook: a equipe não precisa deles.Confiabilidade
| Tema | Como é |
|---|---|
| Disponibilidade | Plataforma disponível 24h, todos os dias. O estado de cada componente (site, portal, API, consultas, documentos, processamento) é verificado e publicado na página de status. |
| Bases externas | As consultas dependem de bases e provedores externos. Quando uma base cai ou demora, a consulta termina em erro com retryable: true e o valor é estornado. Alguns serviços tentam automaticamente uma segunda base antes de devolver erro, sem cobrança dupla. |
| Processamento | Consultas entram numa fila e são processadas em segundo plano. Falha transitória é retentada internamente; falha definitiva (veículo não encontrado, dado inválido) termina na primeira tentativa. Toda consulta que termina em erro é estornada, com reconciliação que confirma o estorno. |
| Limites operacionais | 120 requisições por minuto por conta em produção (60 no sandbox). Ver Limites. |
| Segurança | HTTPS, chave guardada só como hash, isolamento por conta e por ambiente, webhooks assinados. Ver Segurança e LGPD. |
Política de mudanças e versionamento
| Tipo de mudança | Como acontece |
|---|---|
| Acréscimo (campo, serviço, evento, código de erro) | Pode acontecer a qualquer momento, sem nova versão. Integrações que ignoram campos desconhecidos não sentem. Fica registrado no changelog. |
| Mudança incompatível no envelope ou no bloco veiculo | Não acontece dentro de /v1 nem de schema_version 1.x. Exigiria versão nova, com aviso no changelog e caminho de migração. |
| Mudança no conteúdo de dados | O dados espelha a base consultada; quando a base muda, campos podem passar a vir vazios ou com outra grafia. Publicamos no changelog com o selo Atenção. Para forma garantida, use veiculo. |
| Layout de PDF | Pode mudar; avisamos no changelog. Não extraia texto do PDF por posição: use o JSON. |
Contato comercial para integradores
Para contratar em volume, negociar condições para a sua empresa ou combinar uma homologação acompanhada, fale com a área Comercial: Volume de consultas, pacotes e condições para a sua empresa.