Integre seu CRM, ERP ou ferramenta de automação para consultar empresas e enriquecer listas. A API usa chaves de acesso e o mesmo saldo de créditos da plataforma.
Para que serve e para quem é
Se você só consulta empresas de vez em quando, a tela da plataforma basta. A API faz sentido quando:
- o seu sistema precisa completar o cadastro de um cliente pelo CNPJ, na hora em que ele é digitado;
- você quer levar uma lista de empresas da base para outro sistema, por filtro;
- você tem uma lista de CNPJs e quer completar os dados dela de uma vez.
A API só lê dados. Ela não cria, altera nem apaga nada no seu CRM. Para que o seu sistema seja avisado quando algo acontece no CRM, use os webhooks.
Ela está disponível a partir do plano Growth (R$349,90/mês). O teste grátis de 7 dias não inclui a API.
Como gerar a sua chave
- Abra a aba APIEm Configurações da Conta → API. A aba aparece para o proprietário e os administradores da conta; quem é membro pede a chave ao administrador.
- Crie a chaveClique em Nova chave e dê um nome a ela (por exemplo, o sistema que vai usá-la).
- Copie e guardeA chave aparece uma única vez, na criação. Guarde em lugar seguro: se perder, revogue e crie outra.
- Use no seu sistemaCada chamada leva a chave no cabeçalho Authorization, no formato Bearer. Quem integra encontra os exemplos na documentação técnica.
A chave dá acesso aos seus créditos. Não a coloque em página pública, planilha compartilhada ou código que roda no navegador. Se ela vazar, use Cancelar chave na mesma tela: a chave para de funcionar na hora.
O que dá para fazer
| Chamada | O que faz |
|---|---|
| GET /api/v1/empresa/{cnpj} | Devolve os dados de uma empresa: situação, endereço, contatos públicos, atividade e quadro de sócios. Com a opção de enriquecimento ligada, busca também site e contatos na web. |
| POST /api/v1/empresas/buscar | Busca empresas por filtros, como na Busca Avançada. Exige pelo menos 3 filtros e devolve até 100 empresas por página. |
| POST /api/v1/enriquecer | Recebe uma lista de CNPJs e completa os dados de cada um a partir da base pública. Até 100 CNPJs a resposta vem na hora; de 101 a 1.000, o processamento roda em segundo plano. |
| GET /api/v1/enriquecer/{job_id} | Consulta o andamento e o resultado de um lote em segundo plano. |
A lista completa de campos, filtros e respostas, com exemplos de chamada, está na documentação técnica da API.
Quanto custa: créditos rendem o dobro
A API usa o mesmo saldo de créditos da conta (em contas com equipe, o saldo compartilhado da empresa). Nos planos Growth, Scale e Professional cada consulta custa meio crédito, ou seja, cada crédito rende duas consultas:
| O que acontece | Créditos |
|---|---|
| Consultar uma empresa pelo CNPJ | 0,5 |
| Consultar uma empresa com o enriquecimento na web ligado | 2 |
| Busca por filtros, por empresa devolvida (10 empresas) | 0,5 cada (5) |
| Lote de enriquecimento, por CNPJ encontrado (100 encontrados) | 0,5 cada (50) |
| CNPJ não encontrado | 0 |
Duas consultas de meio crédito, mesmo feitas em momentos diferentes, somam um crédito no extrato.
Limites e cuidados
| Plano | Chamadas por minuto |
|---|---|
| Growth | 30 |
| Scale | 60 |
| Professional | 100 |
| Enterprise | sem limite |
- Passou do limite: a chamada volta com o código 429 e pode ser repetida alguns segundos depois. Nada é cobrado por ela.
- Repetir sem pagar duas vezes: nas chamadas POST, envie o cabeçalho Idempotency-Key com um código único por operação. Se a mesma chamada for repetida (por queda de rede, por exemplo), a resposta volta igual e não há nova cobrança.
- Empresas com exibição suprimida a pedido do titular, pela LGPD, não aparecem na API, como não aparecem na plataforma.
Webhooks: o seu sistema avisado na hora
A API é o seu sistema perguntando à LeadCNPJ. O webhook é o contrário: a LeadCNPJ avisa o seu sistema quando algo acontece no seu CRM, sem que ele precise ficar consultando. Está disponível a partir do plano Scale (R$697,90/mês).
- Abra a seção de webhooksEm Configurações da Conta → API, na seção Webhooks do CRM.
- Cadastre o endereçoClique em Novo aviso, informe o endereço do seu sistema (precisa começar com https) e marque quando avisar: negócio ganho, negócio perdido, negócio mudou de etapa, contato criado e contato virou cliente.
- TesteUse Testar para mandar um evento de exemplo e confirmar que o seu sistema recebeu.
Cada aviso leva uma assinatura no cabeçalho X-LeadCNPJ-Signature, para o seu sistema conferir que foi a LeadCNPJ quem mandou. Se o seu sistema estiver fora do ar, o aviso é reenviado algumas vezes antes de desistir. O passo a passo técnico está na documentação da API.
Perguntas frequentes
Preciso saber programar para usar a API?
Alguém precisa ligar o seu sistema à API: um desenvolvedor ou uma ferramenta de automação como Zapier, n8n ou Make. Para consultar empresas pela tela, você não precisa da API.
A API grava dados no meu CRM?
Não. Ela só lê dados da base de empresas. Para levar empresas para o CRM, use a busca da plataforma; para o CRM avisar outro sistema, use os webhooks.
De qual saldo saem os créditos da API?
Do mesmo saldo da plataforma. Em contas com equipe, do saldo compartilhado da empresa.