Servicos externos (APIs)
Visando maior flexibilidade na construção dos assistentes, existe o recurso de integração com serviços corporativos. A integração pode ser feita pelo cadastro de APIs ou com a construção de serviços customizados da senior X Platform. Neste modelo de integração, o usuário informa a URL e os parâmetros do serviço externo que serão consumidos. Os parâmetros podem ser do tipo constantes, em que o usuário informa um valor fixo ou do tipo input, onde o usuário recebe um valor digitado pelo mesmo no momento do diálogo.
Para realizar uma integração com serviço externo utilizando a interface:
- Acesse
- Selecione um BOT existente ou crie um novo;
- Crie um novo assunto e clique na aba Resposta do BOT;
- Selecione Integração para o tipo de resposta do BOT;
- Escolha uma opção do tipo de requisição para definir o método HTTP utilizado para chamar o serviço;
- No campo URL da API insira a URL do serviço.
Adicionando parâmetros na requisição
É possível adicionar dois tipos de parâmetros para realizar a chamada de um serviço externo: input e constante.
- Input: parâmetros do tipo input são aqueles que o BOT irá fazer uma pergunta e passará a resposta do usuário como valor para a requisição;
- Constante: valor que pode ser informado diretamente no cadastro da resposta que será retornada para o usuário.
O BOT utilizará os parâmetros informados para o diálogo com o usuário:
Formato padrão de resposta
A integração do BOT suporta chamadas REST, cuja entrada é um JSON no corpo da requisição. E como resposta, o BOT espera que o serviço chamado retorne no corpo da mensagem um JSON com o seguinte formato:
{
"type": "PLAINTEXT" || "HTML" || "BUTTON" || "IMAGE",
"text": [
"Texto que o serviço vai retornar"
],
"options": [
{
"text":"Título da opção",
"value":"Valor da resposta a ser enviada quando a opção for selecionada",
"url":"Url a ser aberta quando a opção for selecionada"
}
],
"image": {
"url":"url da imagem, disponível na nuvem",
"link":"link a ser aberto quando clicar na imagem",
"text":"texto a enviar quando clicar na imagem"
}
}
Orientações
- || - significa ou. Neste caso, deve mandar alguma das opções, como sendo um campo do tipo texto (string);
- ? - significa que o campo é opcional, porém, pode ser necessário informar pelo menos um campo opcional. Por exemplo, ao enviar o valor ‘HTML’ ou ‘PLAINTEXT’ no campo type, é necessário preencher o campo text com algum texto.
Regras para utilização
Um nó que contenha uma integração não permite adição de nó filho. Caso o usuário tente adicionar, uma mensagem de erro será exibida.
Um nó que contenha uma integração não permite adicionar outra resposta do BOT. Caso o usuário tente adicionar, uma mensagem de erro será exibida.
O Nó permite apenas uma integração. Caso o usuário tente adicionar mais de uma integração, uma mensagem de erro será exibida.
Integração não permite configurar um IR PARA para outra integração. Caso o usuário tente configurar, uma mensagem de erro será exibida.
English
Español
