Captar Leads

Documentação da API

Integre o Captar Leads com seus sistemas para automatizar o cadastro de leads e disparos de mensagens via WhatsApp.

REST API Bearer Token JSON

Autenticação

Todas as requisições à API devem ser autenticadas usando Bearer Token

Para usar a API, você precisa incluir seu token de autenticação no header de todas as requisições. O token pode ser obtido na página API dentro do painel do Captar Leads.

Header de Autenticação
Authorization: Bearer seu_token_aqui
Base URL da API

https://captarleads.com.br/api/public.php

Segurança

Seu token permite apenas o cadastro de novos leads. Ele não dá acesso a dados existentes na sua conta.

Cadastrar Lead

Endpoint para criar novos leads no sistema

POST https://captarleads.com.br/api/public.php

Cadastra um novo lead no sistema. Se a pasta especificada não existir, será criada automaticamente. Opcionalmente, pode agendar um disparo automático para enviar a primeira mensagem via WhatsApp.

Parâmetros do Body (JSON)

Parâmetro Tipo Descrição
nome_empresa obrigatório string Razão social ou nome da empresa
telefone condicional string Telefone com DDD. Obrigatório se email não for informado
email condicional string E-mail de contato. Obrigatório se telefone não for informado
pasta opcional string Nome da pasta. Se não existir, será criada. Padrão: "Leads API"
nome_fantasia opcional string Nome fantasia da empresa
cnpj opcional string CNPJ da empresa
endereco opcional string Endereço completo
cidade opcional string Cidade
estado opcional string Estado (UF - 2 letras)
site opcional string Website da empresa
categoria opcional string Categoria/segmento do lead
disparar opcional boolean Se true, agenda disparo automático de mensagem
agente_id opcional integer ID do agente de IA para o disparo
Dica

Configure o "Disparo Automático" na página de API para não precisar enviar disparar e agente_id em cada requisição.

Respostas

Códigos de status HTTP e formatos de resposta

Códigos de Status

201
Created Lead cadastrado com sucesso
400
Bad Request Parâmetros inválidos ou faltantes
401
Unauthorized Token inválido ou não fornecido
409
Conflict Lead com este telefone/email já existe
500
Internal Server Error Erro interno do servidor

Resposta de Sucesso

JSON
{
    "success": true,
    "lead_id": 12345,
    "pasta_id": 67,
    "pasta_criada": false,
    "disparo_agendado": true,
    "message": "Lead cadastrado com sucesso"
}

Resposta de Erro

JSON
{
    "success": false,
    "error": "Descrição do erro",
    "code": "ERROR_CODE"
}

Exemplos de Código

Implementações em diferentes linguagens

cURL
curl -X POST https://captarleads.com.br/api/public.php \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "nome_empresa": "Tech Solutions LTDA",
    "telefone": "11999887766",
    "pasta": "Leads Site",
    "email": "contato@techsolutions.com.br",
    "cidade": "São Paulo",
    "estado": "SP"
  }'
PHP
<?php
$token = 'SEU_TOKEN_AQUI';
$url = 'https://captarleads.com.br/api/public.php';

$data = [
    'nome_empresa' => 'Tech Solutions LTDA',
    'telefone' => '11999887766',
    'pasta' => 'Leads Site',
    'email' => 'contato@techsolutions.com.br',
    'cidade' => 'São Paulo',
    'estado' => 'SP'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $token
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$result = json_decode($response, true);

if ($result['success']) {
    echo "Lead criado com ID: " . $result['lead_id'];
} else {
    echo "Erro: " . $result['error'];
}
JavaScript
const token = 'SEU_TOKEN_AQUI';
const url = 'https://captarleads.com.br/api/public.php';

const data = {
    nome_empresa: 'Tech Solutions LTDA',
    telefone: '11999887766',
    pasta: 'Leads Site',
    email: 'contato@techsolutions.com.br',
    cidade: 'São Paulo',
    estado: 'SP'
};

fetch(url, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${token}`
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(result => {
    if (result.success) {
        console.log('Lead criado com ID:', result.lead_id);
    } else {
        console.error('Erro:', result.error);
    }
})
.catch(error => {
    console.error('Erro de conexão:', error);
});

Pronto para começar?

Crie sua conta gratuita e comece a integrar seus sistemas com o Captar Leads.

Criar Conta Grátis