Usando o nó API no Chatbot Builder

Você pode usar Call API para chamar uma API diretamente do chatbot. Você também pode usar a resposta da API no fluxo do chatbot.

Configuração do nó API

• API - Você pode selecionar ou configurar os detalhes da API na seção API
• Clique em "Show Editor" para atualizar a configuração da API
• Se estiver usando um payload JSON, você pode digitar {{ para ver uma lista de substituições de variáveis disponíveis
• Você terá acesso ao texto da última mensagem do chat e aos dados coletados pelo chatbot
• Armazenar resposta em variável? - Informe um nome de variável para armazenar a resposta da API
• Caminho JSON do valor a armazenar? - Informe um caminho JSON para extrair um valor específico da resposta JSON e armazená-lo na variável

1. A resposta da API é acessada pela chave response.data
2. então, se a resposta da sua API for { "value": "this is the response" }
3. o caminho JSONPath deverá ser response.data.value

Configurar a saída da API

A API resultará em success (2xx response) ou failure (non 2xx response). Você pode conectar as opções aos nós seguintes conforme necessário.

Guia de configuração do nó API

Abaixo está um guia passo a passo para criar um novo chatbot com o Call API Node

Criar um nó API no Chatbot

1. Crie um Chatbot usando Message Node, Question Node, salvando a resposta do chatbot com Upsert Node e conectando-os em um fluxo
2. Arraste e solte o nó Call API à direita do nó de pergunta
3. Edite o nó Call Api
4. Clique em Show Editor ao lado da API selecionada
5. Faça as alterações necessárias, como informar a URL da API e selecionar o método HTTP
6. Escolha form url encoded ou form multipart como tipo de corpo
7. Clique em Add Another na seção key value
8. Uma nova entrada será criada. Em key, informe o nome da chave, como text. Em value, selecione a variável da consulta
9. Clique em Save API para fechar o editor
10. Em Store response in variable , adicione um nome de variável, como api_response
11. Em JSON path of value to store , adicione um caminho JSON para selecionar um valor específico da resposta da API e armazená-lo
12. 1. A resposta da API é acessada pela chave response.data
    2. então, se a resposta da sua API for { "value": "this is the response" }
    3. o caminho JSONPath deverá ser response.data.value
12. Clique em Save para fechar o editor do nó API

Adicionar um nó de mensagem para a resposta da API

1. Arraste e solte um nó de mensagem à direita do nó API
2. Conecte a opção Success do nó API ao novo nó de mensagem
3. Edite o nó de mensagem
4. Digite uma mensagem para o nó de mensagem. Se quiser acessar os dados retornados pelo nó API, digite @ e comece a escrever para ver um menu com as variáveis disponíveis. Escolha a variável api\_response
5. Clique em Save no nó de mensagem. Em seguida, clique em Save no canto superior direito para salvar o chatbot.

Este chatbot fará uma pergunta ao usuário e, em seguida, chamará a API configurada com a resposta do usuário. Se receber uma resposta da API, ela será enviada de volta ao usuário.