Chamadas de APIs Externas em seus Fluxos de Chat
Esta página contém informações sobre como você pode chamar APIs externas dentro dos seus fluxos de conversa (chat flows).
Atualmente, o componente de chat com API está disponível apenas para o Bot do WhatsApp. Em breve estará disponível para os demais canais.
❓ O que é uma API Externa?
Uma API externa (Interface de Programação de Aplicações) é um conjunto de regras e protocolos que permite que um software interaja e se comunique com outro sistema, serviço ou plataforma externa.
Ela permite que diferentes programas acessem e troquem dados e funcionalidades de forma integrada, mesmo que tenham sido desenvolvidos por organizações diferentes ou estejam hospedados em servidores distintos.
🔧 Tipos de APIs
Existem vários tipos de APIs, cada um com finalidades e casos de uso específicos.
Atualmente, damos suporte a APIs RESTful baseadas em JSON, utilizando:
API Key (chave de API)
Token JWT
APIs públicas (sem autenticação)
🔄 Fluxo de Uso das APIs nos ChatFlows
A seguir, apresentamos o fluxo básico para utilizar APIs dentro dos seus fluxos de chat:
Fluxo de Trabalho para Usar APIs nos ChatFlows
Usando APIs nos Fluxos de Conversa (Chatflows)
Para integrar APIs de forma eficiente nos seus fluxos de conversa dentro da Etherna IA, siga o passo a passo abaixo:
✅ Passo 1: Acesse o Painel da Etherna IA
Faça login na sua conta da Etherna IA e acesse o dashboard principal.
✅ Passo 2: Vá para a Seção de Desenvolvedores
No menu lateral, clique em “Mais”. Dentro da seção "Mais", selecione “Desenvolvedores”.
✅ Passo 3: Prepare os Atributos Personalizados
Antes de prosseguir, verifique se você já criou os atributos personalizados que serão usados nas interações com a API.Esses atributos ajudarão a capturar e organizar os dados.
Consulte a documentação de: Gerenciar e Usar Atributos Personalizados
✅ Passo 4: Adicione uma Nova API
Na seção “Desenvolvedores”, localize “Suas APIs” e clique em “Adicionar API” no canto superior direito.
Adicionar API
✅ Passo 5: Configure Sua API
Em "Configurar APIs", preencha os seguintes campos. A estrutura é semelhante ao Postman:
Nome da API: Nome de exibição para facilitar a identificação.
Método da API: Escolha o método HTTP (ex: GET, POST, PUT).
URL da API: Informe a URL da API que deseja chamar.
Parâmetros de Consulta (Query Parameters): Adicione os parâmetros necessários.
Cabeçalhos (Headers): Inclua os cabeçalhos exigidos pela API.
Corpo da Requisição (Body): Defina o corpo da requisição, se necessário.
Configurar API
Nota: Para inserir variáveis personalizadas na URL ou corpo da requisição, utilize “/” como marcador. Porém, no primeiro momento, use valores reais para testar a estrutura da resposta da API.
✅ Passo 6: Teste a API
Vá até a aba “Gerenciar Resposta da API” e clique em “Testar” usando os valores reais. Isso permitirá que a Etherna IA entenda o formato da resposta da API.
✅ Passo 7: Mapeie a Resposta da API com Atributos Personalizados
Ainda na aba “Gerenciar Resposta da API”, associe os dados retornados pela API aos atributos personalizados da Etherna IA.
✅ Passo 8: Substitua os Valores Reais
Depois de mapear, substitua os valores reais pelos atributos personalizados configurados.
✅ Passo 9: Acesse seu Chatflow
Vá até o fluxo de conversa do seu bot clicando em “Editar seu Chatflow” dentro da seção “Robôs”.
Componente API
✅ Passo 10: Selecione o Componente "API"
Na lista de componentes do chat, selecione o componente “API”.
✅ Passo 11: Chame a API
No painel lateral direito, escolha a API que você configurou anteriormente pelo nome.
Painel
✅ Passo 12: Mapeie as Próximas Perguntas
Defina qual pergunta ou ação será disparada com base no código de resposta da API (ex: 200, 300, etc.).Se o código de resposta não corresponder a nenhum valor definido, será usada a ação padrão vinculada a "outros".
🎉 Pronto!
Sua API está conectada e pronta para melhorar o desempenho do seu chatbot, criando interações dinâmicas
Last updated