🖥️ Chame APIs externas em seus fluxos de chat

O que é uma API externa?

Uma API externa (Interface de Programação de Aplicativo) refere-se a um conjunto de regras e protocolos que permitem que um aplicativo de software interaja e se comunique com outro sistema, serviço ou plataforma de software externo. Ele permite que diferentes programas de software acessem e troquem dados e funcionalidades de maneira integrada, mesmo que sejam desenvolvidos por organizações diferentes ou executados em servidores diferentes.

Tipos de APIs

Existem vários tipos de APIs, cada uma atendendo a propósitos e casos de uso específicos.

No momento, oferecemos suporte a APIs RESTful baseadas em JSON com chave de API, token JWT ou APIs públicas

Fluxos de trabalho de uso de APIs no ChatFlow

Aqui está o fluxo para usar as APIs nos Chatflows

Fluxos de trabalho de uso de APIs no ChatFlow

Usando APIs nos Chatflows

Para integrar APIs perfeitamente aos seus fluxos de bate-papo no Etherna.IA, siga estas etapas:

Etapa 1: acesse o painel do Etherna.IA

• Faça login em sua conta Etherna.IA e acesse o painel.

Etapa 2: navegue até a seção de desenvolvedores

• Na barra de navegação lateral, localize e clique em “Mais”.

• Na seção “Mais”, selecione “Desenvolvedores”.

Etapa 3: preparar atributos personalizados

• Antes de continuar, certifique-se de ter adicionado todos os atributos personalizados necessários para as interações da API. Atributos personalizados ajudarão a capturar e gerenciar dados. Consulte o documento antes de criar e gerenciar os atributos personalizados

Etapa 4: adicionar uma nova API

• Na seção “Desenvolvedores”, encontre “Suas APIs” e clique em “Adicionar API” no canto superior direito.

Etapa 5: configure sua API

• Em "Configurar APIs", defina os detalhes a seguir. A estrutura é semelhante ao Postman para testar APIs:

  • Nome da API : Este é o nome de exibição da API, usado para melhor legibilidade no Etherna.IA.

  • Método API : Especifique o método HTTP (por exemplo, GET, POST, PUT).

  • Insira o URL da API : forneça o URL da API que você pretende chamar.

  • Parâmetros de consulta : adicione quaisquer parâmetros de consulta necessários.

  • Cabeçalhos : inclua os cabeçalhos necessários para a API.

  • Corpo : Defina o corpo da solicitação, se necessário.

Observação: se você deseja inserir variáveis ​​personalizadas na API, use "/" como espaço reservado. No entanto, para a configuração inicial, você precisará inserir os valores reais para testar a API e salvar a estrutura de resposta.

Etapa 6: testar a API

• Vá para "Gerenciar resposta da API" e clique em "Testar" a API com valores reais. Isso ajudará o Etherna.IA a entender a estrutura de resposta da API.

Etapa 7: mapear a resposta da API para atributos personalizados

• Na guia "Gerenciar resposta da API", você pode mapear as variáveis ​​de resposta da API para seus atributos personalizados do Etherna.IA.

Etapa 8: Substitua os Valores Reais

• Se necessário, substitua os valores reais na configuração da API pelos atributos customizados que você mapeou.

Etapa 9: acesse seu fluxo de bate-papo

• Navegue até o fluxo de bate-papo do seu bot clicando em "Editar seu fluxo de bate-papo" na seção "Bots".

Etapa 10: selecione o componente de bate-papo "API"

• Na lista de componentes de chat, escolha o componente de chat "API".

Etapa 11: chame a API

• No painel direito, chame a API selecionando a API que você configurou anteriormente pelo nome.

Etapa 12: Mapeie as próximas perguntas

• Mapeie a próxima pergunta com base no código de resposta da sua API (por exemplo, 200, 300, etc.). Se o código de resposta da API não corresponder a nenhum valor predefinido, ele acionará a resposta mapeada para “outros”.

E pronto! Sua API está pronta para aprimorar a funcionalidade do seu chatbot e fornecer interações dinâmicas com base nas respostas da API.