Todas as coleções
Plataforma AiSensy
Como usar o recurso “Solicitação de API” no chatbot
Como usar o recurso “Solicitação de API” no chatbot

Veja como usar o recurso de Solicitação de API no construtor de Chatbot da AiSensy

Ana Claudia Perazzolo avatar
Escrito por Ana Claudia Perazzolo
Atualizado há mais de uma semana

Ao integrar suas chamadas de API aos fluxos, seu cliente poderá obter o relatório exato simplesmente inserindo detalhes como o número da conta e as datas entre as quais gostaria de receber o extrato da conta.

Isso é possível com a ajuda de chamadas de integração de API, um recurso do construtor de fluxos da AiSensy.

Então, vamos entender como você pode usar o recurso de solicitação de API (API request) no Chatbot.

Como usar o recurso de solicitação de chamadas de API no chatbot?

Ao utilizar o recurso Solicitação de API no Construtor de Fluxo da AiSensy, você pode integrar APIs externas perfeitamente em seus fluxos de conversas e automatizar interações com sistemas externos.

A seguir, iremos explorar como usar o recurso de “Solicitação de Chamadas de API” no construtor de chatbot.

1. Crie um novo fluxo

Vá para Construtor de Fluxos e clique em Criar fluxo.

2. Selecione “Solicitação de API” no Bloco de Conteúdo

3. Configuração de Solicitação de API

Siga as etapas abaixo para configurar solicitações de API:

1. URL

Especifique a URL do endpoint da API com o qual você deseja se comunicar. Este URL deve ser semelhante ao usado no Postman.

Captura de tela 27/06/2023 às 11/08/36.png

Captura de tela 27/06/2023 às 11/08/45.png

2. Tipo de solicitação

Selecione o tipo de solicitação apropriado entre as opções disponíveis: GET, POST, PUT, PATCH ou DELETE.

Captura de tela 27/06/2023 às 11/09/06.png

Captura de tela 27/06/2023 às 11/09/26.png

3. Parâmetros

Os usuários podem fornecer valores estáticos para os parâmetros ou selecionar atributos para compartilhar informações dinâmicas dentro do fluxo.

Captura de tela 27/06/2023 às 11/09/56.png

4. Cabeçalhos

Inclua todos os cabeçalhos necessários para sua solicitação de API. Os cabeçalhos fornecem informações adicionais sobre a solicitação, como credenciais de autenticação ou tipo de conteúdo.

Captura de tela 27/06/2023 às 11h10.46.png

5. JSON Raw Data

Se necessário, você pode enviar JSON raw datas como parte do corpo da solicitação. Os usuários podem passar valores de atributos dentro do objeto JSON usando o sinal $ seguido do nome do atributo.

Captura de tela 27/06/2023 às 11/11/12.png

6. Teste a API

Depois de configurar a solicitação da API, clique no botão “Testar” para enviar a solicitação e verificar sua funcionalidade. Isso simulará uma chamada de API e fornecerá a resposta.

Captura de tela 27/06/2023 às 11/11/31.png

7. Capturar dados de resposta

Após uma resposta de API bem-sucedida, você tem a opção de capturar dados específicos da resposta e salvá-los como valores de atributos. Isso permite armazenar e usar os dados recuperados em seu fluxo para processamento posterior.

Captura de tela 27/06/2023 às 11h56min28.png

Captura de tela 2023/06/27 às 11h56min37s.png

8. Salve a solicitação

Se estiver satisfeito com a solicitação de API configurada, você pode clicar no botão "Salvar" para armazenar a solicitação para uso futuro. Isso garante que suas configurações de solicitação sejam preservadas e possam ser facilmente acessadas quando necessário.

Captura de tela 27/06/2023 às 11h56.43.png

Definindo a configuração em Nível de Bloco

No Construtor de Fluxos, você pode definir ações em nível de bloco (block-level actions) com base nos status code de resposta da API. As opções disponíveis incluem “Status Fallback” e “Custom”.

Captura de tela 27/06/2023 às 11h57min08.png

1. Status Fallback

Defina uma ação de fallback a ser executada quando a API responder com um status code específico. Por exemplo, se a API retornar um status code 404 (Not Found), você poderá redirecionar o fluxo para outro bloco ou executar uma ação específica.

Captura de tela 27/06/2023 às 11h57min34s.png

2. Personalizado

Personalize o fluxo com base em diferentes status code. Você pode adicionar vários redirecionamentos para diferentes cenários.

Por exemplo, redirecionamento para um bloco específico baseado em um status code 200 (OK) e vice-versa para outros códigos de status.

Ao utilizar o recurso Solicitação de API no Construtor de Fluxo da AiSensy, você pode integrar APIs externas perfeitamente em seus fluxos de conversas e automatizar interações com sistemas externos.

Deseja integrar as chamadas de API (API calls) em seus fluxos para buscar e enviar dados diretamente para seus endpoints/CRM?

O construtor de chatbot da AiSensy permite integrar chamadas de API em seus fluxos. Você pode fazer solicitações HTTP usando vários tipos de solicitações, como GET, POST, PUT, PATCH e DELETE. Além disso, você pode personalizar a solicitação adicionando parâmetros e cabeçalhos e enviando dados brutos JSON (JSON raw data).

Mas, qual é exatamente a utilidade desse recurso? Bem, vamos entender com um exemplo simples.

Você é um banco e deseja que seus usuários possam obter saldos e extratos de conta atualizados diretamente no WhatsApp sempre que solicitarem.

Respondeu à sua pergunta?