API - Configurações

Atenção

Disponível para o perfil: Administrador

A página de API do sistema Connect.ai é o ambiente destinado à integração técnica entre a plataforma e sistemas externos (como CRMs, sites, ERPs ou automações de marketing). Através desta tela, o administrador gera chaves de acesso, consulta a documentação técnica e testa as rotas de comunicação em tempo real.

Atenção

Uma API por canal: cada integração criada em + Nova API é vinculada a uma única Sessão (canal de WhatsApp). Se você precisa disparar por mais de um canal, crie uma API separada para cada um — não é possível usar a mesma chave/token para múltiplos canais.

Principais funções

• Gestão de Tokens: Criação e revogação de chaves de autenticação.
• Documentação Interativa: Acesso direto à lista de endpoints e parâmetros.
• Sandbox: Ambiente de teste para validar requisições sem sair do painel.
• Webhooks: Configuração de disparos automáticos de eventos do sistema para URLs externas.

Caso de uso

Uma empresa utiliza um CRM externo para gerenciar suas vendas. Através da API, o desenvolvedor integra os sistemas para que, toda vez que um negócio for movido para "Fechado" no CRM, o Connect.ai envie automaticamente uma mensagem de boas-vindas ao Contato utilizando uma Sessão WhatsApp específica.

Atenção

Como acessar a página

No menu lateral, clique no Menu Configuração e na aba API.

!

Você verá a seguinte tela:

!

Explicação dos campos e ícones

• Botão Postman: Atalho para baixar a coleção de requisições pré-configuradas para uso no software Postman.
  • https://www.postman.com/comunidade-Connect.ai/Connect.ai/collection/s16subg/postman-v3-x-x-x?action=share&creator=25151510&sideView=agentMode
• Botão + Nova API: Abre o formulário para gerar uma nova integração vinculada a um canal.
• URL de Integração: O endereço base que deve ser utilizado nas chamadas externas.
• Bearer Token: A chave secreta de autenticação.
• Ícones de Ação:
  • Atualizar (Seta circular): Gera um novo token para a API selecionada (o anterior é invalidado imediatamente).
  • Editar (Lápis): Permite alterar o nome da integração.
  • Excluir (Lixeira): Remove a integração e invalida o acesso externo permanentemente.
  • Olho / Copiar: Permite visualizar o token oculto e copiá-lo para a área de transferência.

---

Criando uma API

1. Clique no botão + Nova API no canto superior direito.
2. No modal que aparecerá, dê um Nome identificador para a integração (ex: CRM Vendas).
3. Selecione a Sessão (canal de WhatsApp) que será utilizada para os disparos desta API.
4. Clique em Salvar.
5. Importante: Copie o token gerado imediatamente. Por questões de segurança, recomenda-se o armazenamento em local seguro, pois ele é a chave de acesso ao seu sistema.

!

Usando a API e Documentação

Para facilitar o desenvolvimento, o Connect.ai disponibiliza uma documentação completa e testável dentro da própria interface:

1. Consulte a seção Documentação de rotas para visualizar todos os Endpoints disponíveis.
2. Utilize o Sandbox selecionando uma API ativa no menu suspenso. Isso permite que você preencha os parâmetros e teste a requisição diretamente na página para ver a resposta do servidor.
3. A autenticação de todas as chamadas deve ser feita via Header: Authorization: Bearer {seu_token}.

!

Webhooks e Eventos

Os Webhooks permitem que o Connect.ai "fale" com o seu sistema externo em tempo real quando algo acontece:

• Configuração: Informe a URL de callback no campo de destino.
• Eventos Disponíveis: O sistema pode notificar sobre novas mensagens recebidas, tickets abertos, alterações de status e confirmações de entrega.
• Otimização: Filtre apenas os eventos que são estritamente necessários para sua integração, reduzindo o tráfego de dados desnecessário.