A API do Eddie permite iniciar e continuar conversas automaticamente com fluxos criados, por meio de chamadas HTTP. Essa funcionalidade é ideal para realizar testes automatizados, validar interações e garantir que os fluxos estejam funcionando conforme o esperado.
Esse guia apresenta o processo completo para uso da API.
Visão Geral da Integração
A comunicação com o Eddie é feita em duas etapas principais:
-
Início da conversa: cria uma nova sessão de chat.
-
Continuidade da conversa: envia mensagens dentro da sessão criada.
Essas chamadas são feitas através de endpoints HTTP, utilizando um token de autenticação e o ID do fluxo criado no Eddie.
Passo a Passo para Integração
1. Obtenha o ID do fluxo
Cada fluxo criado no Eddie possui um identificador único (ID), que é utilizado para iniciar a sessão via API. Esse ID pode ser copiado diretamente na URL de edição do fluxo ou na tela de publicação.
2. Inicie uma nova sessão de conversa
Endpoint:
POST https://eddieeyes.us-east-1.prd.cloudhumans.io/api/v1/typebots/ID_DO_FLUXO/startChat
Headers obrigatórios:
-
Content-Type: application/json -
Authorization: Bearer {{apiToken}}
Resposta esperada:
{ "sessionId": "abc123xyz"}
Esse sessionId é essencial para os próximos passos.
3. Envie mensagens para continuar o chat
Endpoint:
POST https://eddieeyes.us-east-1.prd.cloudhumans.io/api/v1/sessions/{{sessionId}}/continueChat
Headers:
-
Content-Type: application/json -
Authorization: Bearer {{apiToken}}
Body:
{ "message": "mensagem do usuário"}
Resposta: um objeto JSON com a próxima interação gerada pelo Eddie com base na lógica do fluxo.
Como gerar um token
Para autenticar as chamadas via API, você precisa de um API Token. Siga os passos abaixo para gerar:
-
Clique em Configurações e membros no canto superior direito da tela.
-
No menu lateral, selecione Minha conta.
-
Na seção API tokens, clique em Criar para gerar um novo token.
Boas práticas para uso da API
Armazenamento e reuso do sessionId
Guarde o sessionId gerado para cada conversa. Ele é necessário para manter a continuidade da interação com o mesmo contexto.
Testes antes da integração final
Utilize ferramentas como Postman ou Insomnia para validar os endpoints, headers, corpo e respostas. Isso evita erros no ambiente de produção.
Monitoramento de erros
Falhas em chamadas (como dados inválidos, endpoints incorretos ou timeout) aparecem no HUB com sinalização de erro. Utilize essas informações para diagnóstico rápido.