ADS-TOOLSAPI Docs

Postman Collection

Use nossa coleção Postman para testar rapidamente todos os endpoints da API. A coleção inclui exemplos prontos e variáveis de ambiente configuráveis.

Download da Coleção

ADS-Tools API Collection

Versão 1.0 • Atualizado em Fev 2026 • 46 endpoints

Download CollectionEnvironment (Dev)Environment (Prod)

Endpoints Incluídos

Sync API (Recomendado)

  • POST /sync
  • GET /sync/:externalId
  • DELETE /sync/:externalId

Leads

  • POST /leads
  • GET /leads/:identifier
  • PATCH /leads/:uuid/status
  • POST /leads/:uuid/tags
  • DELETE /leads/:uuid/tags/:tagId

Contacts

  • POST /contacts
  • GET /contacts/lookup
  • GET /contacts/:identifier

Tags

  • GET /tags
  • POST /tags

Interactions

  • POST /leads/:id/interactions
  • GET /leads/:id/interactions

Conversations

  • POST /conversations
  • GET /conversations
  • GET /conversations/:id
  • POST /conversations/:id/messages
  • GET /conversations/:id/messages
  • PATCH /messages/:id/status

Como Usar

1

Importar a coleção

No Postman, clique em Import e selecione o arquivoads-tools-postman-collection.json.

2

Importar o environment

Importe também o arquivoads-tools-postman-environment.json.

3

Configurar variáveis

No environment importado, configure as variáveis:

baseUrlURL da API (já configurada para localhost)
apiKeySua API Key (ads_live_... ou ads_test_...)
4

Executar requisições

Selecione o environment no dropdown superior direito e execute qualquer requisição da coleção.

Variáveis do Environment

VariávelDescriçãoExemplo
baseUrlURL base da APIhttps://dev-api-tools.helbioads.com/api/v1/integration
apiKeySua API Keyads_live_abc123...
leadUuidUUID do lead (preenchido automaticamente)a1b2c3d4-e5f6-7890-...
contactIdID do contato (preenchido automaticamente)123
externalIdID externo para testeschat_conversation_123
conversationIdID da conversa (preenchido automaticamente)clx123abc456

Scripts Automáticos

A coleção inclui scripts que executam automaticamente após cada requisição:

  • Ao usar o Sync, o UUID do lead é salvo automaticamente em leadUuid
  • Ao criar um contato, o ID é salvo em contactId
  • Ao criar conversa/mensagem, os IDs são salvos em conversationId e messageId
  • Testes automáticos validam o status code e estrutura da resposta

Alternativas

Swagger UI

Documentação interativa com "Try it out" direto no navegador.

Abrir Swagger

cURL

Todos os exemplos da documentação usam cURL.

Ver Exemplos