API de consultas da plataforma
Use as consultas, os pacotes e a consulta personalizada do Leads B2B Brasil no seu sistema. Cada chamada com resultado debita do saldo da conta dona da chave, o mesmo saldo da aba Créditos. Se a pesquisa não retornar resultado, ela não é cobrada. Os valores aparecem só dentro da plataforma.
Acesso
- Entre na plataforma e abra API & MCP. Dê um nome à chave e marque, no checklist, os campos que ela poderá usar. Sem campos marcados, a chave não acessa nenhuma rota.
- Copie a chave na hora: ela aparece uma vez só. Guarde-a no cofre de segredos do seu servidor.
- Envie a chave no cabeçalho
Authorization: Bearer <chave>ouX-API-Key: <chave>. - Na mesma aba você vê as suas chaves, o uso de cada uma e pode revogar uma chave a qualquer momento.
Rotas
URL base https://leadsb2bbrasil.com/api/v1. A lista completa, com os parâmetros de cada rota e os campos que ela exige na chave, está no contrato OpenAPI e na aba Documentação de API & MCP.
| Rota | Uso |
|---|---|
GET /cpf/regular, /cpf/pro, /cpf/leads | Pacotes por CPF (ou pelas outras buscas aceitas, listadas no contrato). A chave precisa ter todos os campos do pacote. |
GET /cnpj/regular, /cnpj/pro, /cnpj/leads | Pacotes por CNPJ. A chave precisa ter todos os campos do pacote. |
GET /consulta/<pesquisa> | Uma pesquisa avulsa (ex.: /consulta/leads, /consulta/placa). A chave precisa ter o campo equivalente. |
GET ou POST /personalizada | Consulta personalizada: cpf ou cnpj e, se quiser, a lista de campos, entre os habilitados na chave (sem a lista, valem todos os campos da chave). Cobra só os campos que voltaram resultado. |
POST /lote e POST /lote/{id}/confirmar | Consulta em lote: até 5000 CPF, CNPJ, telefones e e-mails. Sem confirmar, nada é debitado. Com confirmação, cada item com resultado debita o produto escolhido no catálogo. GET /lote/{id} e GET /lote/{id}/linhas acompanham a tabela. O parâmetro tipo filtra cpf, cnpj, telefone ou email. |
Exemplo de consulta: escolha as saídas para limitar o consumo
Os exemplos usam um CPF fictício. O parâmetro campos escolhe quais saídas a chamada traz, entre as habilitadas na chave: só elas são consultadas e cobradas. Sem campos, valem todos os campos da chave. Campo fora da chave recebe 403. Se a pesquisa não retornar resultado, ela não é cobrada.
curl
curl 'https://leadsb2bbrasil.com/api/v1/personalizada?cpf=12345678909&campos=telefones,email' \
-H "Authorization: Bearer $LEADS_API_KEY"
# Também numa rota de pacote: só os campos pedidos, pelo preço de cada campo
curl 'https://leadsb2bbrasil.com/api/v1/cpf/pro?cpf=12345678909&campos=telefones' \
-H "Authorization: Bearer $LEADS_API_KEY"
JavaScript (Node 18+)
const campos = ['telefones', 'email']; // as saídas que o seu sistema usa
const r = await fetch(`https://leadsb2bbrasil.com/api/v1/personalizada?cpf=12345678909&campos=${campos.join(',')}`, {
headers: { Authorization: `Bearer ${process.env.LEADS_API_KEY}` },
});
const dados = await r.json(); // dados.cobrado, dados.preco, dados.campos, dados.dossie
Python
import os, requests
campos = ["telefones", "email"] # as saídas que o seu sistema usa
r = requests.get("https://leadsb2bbrasil.com/api/v1/personalizada",
params={"cpf": "12345678909", "campos": ",".join(campos)},
headers={"Authorization": f"Bearer {os.environ['LEADS_API_KEY']}"}, timeout=60)
dados = r.json() # dados["cobrado"], dados["preco"], dados["campos"], dados["dossie"]
Servidor MCP
O mesmo conjunto de consultas está em https://leadsb2bbrasil.com/api/mcp, no transporte Streamable HTTP. A chave vai no mesmo cabeçalho. Cada tool debita o saldo da conta como a rota equivalente. Sem resultado, não há débito.
Cursor (mcp.json)
{
"mcpServers": {
"leadsb2b-brasil": {
"url": "https://leadsb2bbrasil.com/api/mcp",
"headers": { "Authorization": "Bearer SUA_CHAVE" }
}
}
}
Claude
{
"mcpServers": {
"leadsb2b-brasil": {
"type": "http",
"url": "https://leadsb2bbrasil.com/api/mcp",
"headers": { "Authorization": "Bearer SUA_CHAVE" }
}
}
}
Respostas e erros
- Respostas em JSON. Erros no formato
{ "ok": false, "erro": { "codigo", "mensagem" } }. - Em
401, confira a chave (ausente, inválida ou de formato antigo: gere uma nova). Em402, recarregue créditos na aba Créditos; nada é consultado. - Em
403, a chave foi revogada ou não tem os campos que a rota exige; a resposta lista quais. Nada é consultado nem cobrado. - Em
422, confira os parâmetros. Em429, aguarde o tempo deRetry-Aftere repita. - Se a pesquisa não retornar resultado, ela não é cobrada. A resposta traz
cobrado: falseesem_resultado: true; erro da fonte (5xx, tempo esgotado) também não é cobrado. - A mesma pesquisa repetida no mesmo dia não é cobrada de novo, até 23:59 (horário de Brasília).