ADS-TOOLSAPI Docs

Início Rápido

Configure sua primeira integração com a API ADS-Tools em 5 minutos.

Pré-requisitos

  • Conta ativa no ADS-Tools
  • Acesso ao dashboard do cliente
  • Ferramenta para testar APIs (Postman, curl, etc.)
Para usar a API, você precisa de uma API Key. Acesse seu dashboard para criar uma.Obter API Key
1

Obter sua API Key

Acesse o dashboard e navegue até Configurações → API Keys. Crie uma nova API Key com os escopos necessários para sua integração.

Importante: A API Key completa só é exibida uma vez. Guarde-a em um local seguro.

Escopos recomendados para começar:

  • • sync:write - Sincronização de dados
  • • leads:read - Leitura de leads
  • • leads:write - Criação/atualização de leads
2

Testar a conexão

Verifique se sua API Key está funcionando com uma requisição simples:

Bash
curl -X GET "https://dev-api-tools.helbioads.com/api/v1/integration/health" \
  -H "Authorization: Bearer YOUR_API_KEY"

Resposta esperada: status da API e informações do integrador autenticado.

3

Criar seu primeiro lead

Use o endpoint /api/v1/integration/sync para criar um lead:

Bash
curl -X POST "https://dev-api-tools.helbioads.com/api/v1/integration/sync" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "meu-primeiro-lead",
    "contact": {
      "name": "João Silva",
      "email": "joao@example.com",
      "phone": "+5511999999999"
    },
    "lead": {
      "source": "api-test",
      "status": "open"
    },
    "tags": ["teste", "api"]
  }'

Dica: O campo externalId é usado para identificar o lead na sua aplicação. Use um ID único do seu sistema.

4

Verificar a resposta

Uma resposta bem-sucedida terá este formato:

JSON
{
  "success": true,
  "message": "Sync completed successfully",
  "data": {
    "contact": {
      "id": "clx123abc...",
      "externalId": "meu-primeiro-lead",
      "name": "João Silva",
      "email": "joao@example.com"
    },
    "lead": {
      "id": "clx456def...",
      "status": "open",
      "tags": ["teste", "api"]
    },
    "tags": {
      "created": 2,
      "linked": 2
    }
  }
}
5

Próximos passos

Parabéns! Você criou seu primeiro lead via API. Agora explore:

Sync API completa

Sincronize leads, contatos, tags e interações em lote

Configurar Webhooks

Receba notificações quando leads forem atualizados

Autenticação avançada

Escopos, rate limiting e boas práticas

Precisa de ajuda?

Entre em contato com nosso suporte técnico ou acesse a documentação completa.

Falar com SuporteVer Documentação Completa