Este documento tem o objetivo de demonstrar o fluxo do processo de integração do BOT da Plataforma com sistemas externos, proporcionando que o cliente final possa obter através das interações com o BOT construído na Plataforma, informações de um sistema externo. A API foi construída utilizando o protocolo REST/JSON, com criptografia OATUH e autenticação BASIC baseada em um hash gerado pela Plataforma. Com isto, fornecemos toda liberdade ao sistema externo para entregar quantas informações forem necessárias para seus clientes finais.

FLUXO MACRO DE INTEGRAÇÃO

ESTRUTURA DA API SEGUINDO O FLUXO

PASSO 1: Configurar a etapa do fluxo da Plataforma, os parâmetros abaixo necessários para direcionar a integração.

Campos da tela de configuração

Redirecionamento Final: deverá ser escolhida a opção Executar função;

Tipo Função: deverá ser escolhida a opção Externa;

Método: a ser definido pela API externa, normalmente POST;

Usar Token: habilita a possibilidade informar um token pra conectar na API externa;

Token Externo: Informar o Token que a API externa está esperando receber pra autenticação;

Url Externa: é a url da API externa, que será o endereço que a Plataforma estará enviando todas requisições.

Exemplo de como a Plataforma faz a requisição pra API externa.

Exemplo detalhado do JSON que o BOT da Plataforma, estará enviando para a url da API externa, que foi configurada no BOT para poder iniciar as tratativas.

PASSO 2: O time de desenvolvimento do sistema externo, construíra API para receber as informações que o BOT da Plataforma estará a partir do momento da configuração do PASSO 1, após fazer os processamentos e devolver como resposta da chamada do BOT os retornos que o usuário escolheu no BOT.

Retorno do sistema externo

{  "type": "text", 

"content": "Escolha uma opção:\n1 - Boleto Vencimento: 10/09/2022 | Valor: R$ 99.90\n2 - Boleto Vencimento: 10/10/2022 | Valor: R$ 99.90\n3 - Boleto Vencimento: 10/11/2022 | Valor: R$ 99.90\n4 - Boleto Vencimento: 10/12/2022 | Valor: R$ 99.90", 

"id_contato": "1", 

"protocolo": "179594711", 

"id_cliente": "1", 

"estagio_funcao": "1", 

"cel_contato": "1"", 

"nome_contato": "JOÃO DA SILVA",

  "cel_contato": "6984000685", 

"cel_conectado": "6999765792",

  "finaliza_protocolo": "0", 

"voltar_estagio": "1" }

PASSO 3: A API do Plataforma irá receber o retorno, irá processar as informações e entregar no BOT tudo que for enviado pelo sistema externo no BOT do usuário.