API v1.0

ADS-Tools API

Integre leads, contatos e campanhas de marketing digital com a nossa API RESTful. Sincronize dados em tempo real com seu CRM ou aplicação.

Começar Ver Swagger

Autenticação Segura

API Keys com escopos granulares e rate limiting configurável por cliente.

Sync em Tempo Real

Sincronize leads, contatos e interações em uma única requisição.

Webhooks

Receba notificações em tempo real de eventos importantes.

Exemplo Rápido

Crie um lead com uma única requisição usando o endpoint /api/v1/integration/sync

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": "lead-123",
    "contact": {
      "name": "João Silva",
      "email": "joao@example.com",
      "phone": "+5511999999999"
    },
    "lead": {
      "source": "landing-page",
      "status": "open"
    },
    "tags": ["interessado"]
  }'

Documentação

Início Rápido

Configure sua primeira integração em 5 minutos.

Autenticação

Aprenda sobre API Keys, escopos e rate limiting.

Sync API

O endpoint principal para sincronização de dados.

Webhooks

Receba notificações de eventos em tempo real.

Endpoints Disponíveis

Método	Endpoint	Descrição
POST	`/api/v1/integration/sync`⭐ Principal	Sincronização unificada
GET	`/api/v1/integration/sync/:externalId`	Buscar dados por externalId
POST	`/api/v1/integration/leads`	Criar lead
GET	`/api/v1/integration/leads/:identifier`	Buscar lead
POST	`/api/v1/integration/contacts`	Criar contato
GET	`/api/v1/integration/contacts/lookup`	Buscar contato
GET	`/api/v1/integration/tags`	Listar tags
POST	`/api/v1/integration/leads/:id/interactions`	Adicionar interação
POST	`/api/v1/integration/conversations`	Criar conversa

Ver documentação completa →

Rate Limiting

100 req/min padrão. Configurável por cliente.

Latência

P95 < 200ms para endpoints principais.

SLA

99.9% uptime garantido.