Integrações

Objetivo

Este artigo tem como objetivo descrever o processo de integração de ações utilizando API através da plataforma Ubots Desk.

Detalhes

Com o bot builder é possível realizar integrações através da Plataforma Ubots para tornar seu chatbot transacional e permitir que seus clientes consigam executar tarefas diretamente no chatbot de forma fácil e eficiente.

Para realizar uma integração, o primeiro passo é acessar a tela Chatbots > Integrações e cadastrar uma nova integração. Ao clicar em Nova integração você irá inserir o nome da API que será consultada (conjunto de requisições) e a URL. Em seguida, deve-se cadastrar os headers base (necessários em todas requisições desta integração). Todas essas informações necessárias para o preenchimento devem estar documentadas junto ao time de TI da sua empresa.

O campo Requisição anterior deve ser habilitado caso haja alguma requisição que necessite autenticação e deve ser preenchido de modo a apontar para a requisição a ser feita, configurando também o tempo de expiração dos dados da requisição (lembrando que somente é possível apontar pra requisições dentro de uma mesma coleção, e não para requisições de outras coleções).

O próximo passo é o cadastro das requisições, no qual podem ser preenchidos os 4 (quatro) módulos: geral, body, exemplo de resposta e headers.

Em Geral, dê um nome para sua requisição (consultar saldo, por exemplo) e escolha o método de requisição (get/put/post/delete/patch). Em Path, você indicará o caminho a ser chamado (saldo do cliente, seguindo o exemplo). E, por fim, habilite a integração em “Disponível para uso em habilidades do bot”.

O módulo Body pode ser usado para enviar um conteúdo na integração.

Já em Exemplo de resposta, você irá inserir o modelo de resposta que a integração retorna.

Em Headers você irá preencher caso existam cadastros específicos para aquela requisição (caso alguma consulta necessite uma autenticação, por exemplo). Ao adicioná-lo, insira a chave e o valor do header, que também devem ser fornecidos na documentação da sua empresa.

Assim como na criação dos bots, no cadastro de uma integração também é possível utilizar dados coletados no chatbot (como um CPF ou id do usuário) para tornar suas integrações dinâmicas. Caso não se tenha certeza de qual valor deve ser usado, pode-se usar a sintaxe {{cpf}} que só seria requisitado na hora do uso da integração no componente.

É possível inserir tais informações tanto no Path, no Body ou nos Headers. Para isso, a sintaxe que determina uma variável é a mesma que utilizamos nos bots (por exemplo: ${cpf}). Por fim, dados que são retornados de uma integração só podem ser obtidos através da sintaxe ${integration.token}.