❓ Para que serve o bloco de Integrações?
O Bloco de integração do BotConversa é utilizado para realizar REQUISIÇÕES à APIs externas dentro de seu próprio fluxo do botconversa.
De forma prática, toda integração que será realizada dentro do próprio fluxo de conversa, poderá utilizar o bloco de integração, pois ele durante a execução do fluxo realiza a requisição e retorna com os dados para o prosseguimento do fluxo. (exemplo: durante o fluxo, perguntar o CEP do contato, realizar uma consulta em uma API e retornar com o nome da rua do contato).
❓ Quais são os métodos de integração existentes?
Em uma integração API, é utilizando urls HTTP, ou seja, através desses links poderá ser enviado dados, como também receber dados. Para isso, existem os métodos presentes dentro do bloco de integração, o qual deverá ser selecionado de acordo com a documentação API do software que deseja integrar. Esses métodos são:
GET: Receber algum dado externo para dentro do BotConversa.
POST: Enviar dados do BotConversa para outros softwares via API.
PUT: Usado para atualizar alguma informação de forma Completa.
PATCH: Usado para atualizar alguma informação de forma Parcial.
DELETE: Método dedicado para deletar informações ou configurações.
Lembrando que, para realizar qualquer integração e saber qual método usar, deverá ter em mãos a documentação API da ferramenta que deseja integrar com o BotConversa.
❓Qual é a estrutura do bloco de integrações?
- Headers:
Esse é um campo muito importante, pois é nesse campo que será utilizando parâmetros, chaves de autenticação e poderá informar o agente do usuário. Desde já, é importante pontuar que o uso desse campo está diretamente ligado à documentação API de um sistema, deverá observar com atenção todos os detalhes do que deve ser usado no Header da Requisição.
- Body:
Quando você precisa enviar dados de um cliente (como de um navegador web) para sua API, você o envia como um corpo (body) da requisição. O corpo da requisição é a informação enviada pelo cliente para sua API. Poderá enviar pelo corpo de sua requisição campos personalizados do usuário, do robô e também do sistema, como telefones, emails e entre outros.
- Resposta
O campo de resposta é basicamente o retorno da sua requisição API, por ele você receberá uma mensagem de sucesso quanto também receberá seus dados de uma requisição GET, podendo mapear posteriormente na aba de Mapeamento de Resposta, como verá abaixo.
- Mapeamento da Resposta:
Esse campo do bloco de integração é um dos mais importantes, pois é nele que será realizado o mapeamento de sua requisição, para dentro do BotConversa, podendo usar essas informações nos seus fluxos. Basicamente, deverá selecionar qual índice deseja salvar de sua resposta e depois selecionar o campo personalizado na companhia. Nesse exemplo abaixo, estamos pegando a resposta Bairro da requisição API, e salvando no campo personalizado Bairro dentro do BotConversa:
➕ Saídas do Bloco de Integração:
No bloco de integração do BotConversa, existem 2 saídas, sendo a saída de CIMA a de Resposta com sucesso. Ou seja, a saída de cima do bloco é executada somente quando a requisição for realizada e tiver um retorno, já a saída de baixo é executada instantaneamente, dando prosseguimento no fluxo.
Importante: A saída de cima possui um time-out de 10 segundos, ou seja, se o bloco de integração não obtiver um retorno em até 10 segundos, o fluxo será continuado sem as informações.
