O bot do CXM de Atendimento PipeRun pode ser facilmente integrado com outros sistemas através do uso da ação HTTP Request que utiliza comandos de API para executar determinadas tarefas, como buscar dados de clientes, buscar informações financeiras de um contrato, entre outras funções.

Atenção! Este artigo exige conhecimentos técnicos em API Rest, tendo em vista que será necessário configurar as ações de HTTP Request com comando de API. Através destes comandos são realizadas transferências de dados do BOT do CXM de Atendimento para servidor, utilizando diversos protocolos HTTP.

Confira neste artigo como configurar as propriedades da ação HTTP Request.

TÓPICOS DO ARTIGO

  1. Como configurar a ação HTTP Request
  2. Como configurar a ação http request
  3. Caso de uso: como realizar uma autenticação
  4. Caso de uso: buscar um cliente pelo número do documento digitado
  5. Caso de uso: buscar dados da fatura

COMO CONFIGURAR A AÇÃO HTTP REQUEST

1. No painel administrativo, clique em "Cadastros" (1), a seguir clique em "Bot's" (2) e após, clique em "Cadastro" (3).

2. Para acessar a área do construtor do bot você poderá clicar em "Adicionar" (1), para criar um novo bot ou clicar em "Configurar fluxo" (2) para editar um fluxo já construído.

Dica: para saber criar um fluxo de bot, acesse este artigo.

3. Na tela do construtor do bot , clique no menu da esquerda em "Ações" (1) a seguir, localize a ação HTTP Request.

4. Clique na ação e arraste para conectar com o contexto já criado.

5. Clique na ação para configurar suas propriedades.

Configure os seguintes campos:

  • Novo contexto se executou com sucesso: crie um contexto para tratar a situação em que a ação retornou sucesso no envio do comando de API.
  • Novo contexto se houver um erro na execução: crie um contexto para tratar a situação em que a ação enviada pelo comando API não retornou sucesso.
  • Comando cURL: informe a linha de comando que deseja que a ação execute.
  • Nó inicial do retorno: caso deseje trazer informações específicas do JSON informe o nome do campo. Se deixar em branco a ação retornará todas as informações.

6. Ao finalizar as configurações das propriedades da ação ela ficará conforme exemplo da imagem.

Pronto! Agora você já sabe como configurar a ação HTTP Request.

CASO DE USO: COMO REALIZAR UMA AUTENTICAÇÃO

1. Caso opte por utilizar as ações de HTTP Request para integrar o CXM de Atendimento com seus CRM ou ERP é necessário que no Bot seja inserida, logo no início do fluxo uma ação de HTTP Request para fazer a autenticação entre os dois sistemas.

Veja um exemplo de linha de comando de API utilizado para fazer esta autenticação:

curl -X 'POST' \  'https://apicore.empresa.com.br/api/Autenticacao' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json' \
  -d '{
  "usuario": "pipecxm2",
  "senha": "Y9cyv!51enqU"
}'

2. Ao ser executada a ação retornou algumas variáveis que podem ser utilizadas ao longo da jornada do bot. Observe o exemplo de variáveis que o comando cURL retornou para o bot.

CASO DE USO: BUSCAR UM CLIENTE PELO NÚMERO DO DOCUMENTO DIGITADO

1. Após inserir a ação HTTP Request para realizar a autenticação no servidor, é possível inserir uma pergunta no fluxo solicitando que o cliente digite o seu CNPJ. A partir da informação digitada pelo cliente será configurada uma nova ação HTTP Request que irá pesquisar o cliente cadastrado.

2. Na ação "Enviar pergunta" (1) é solicitado que o cliente digite o CNPJ, a seguir no contexto "Guardar CNPJ" (2) a informação digitada será armazenada em uma variável. Na ação seguinte utilizamos a ação HTTP Request para pesquisar o cadastro do cliente no servidor.

Para saber mais sobre como enviar perguntas e guardar a resposta em variáveis, consulte este artigo.

3. Veja qual foi o comando utilizado nesta ação, onde a variável @documentobot armazena o número do CNPJ digitado e @token guarda o token gerado na ação de realizar autenticação.

curl -X 'GET' 
\'https://apicore.empresa.com.br/api/NG/NGCliente/lista-contratos-extratos?documento=@documentobot' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer @token'

CASO DE USO: BUSCAR DADOS DA FATURA

1. A partir do número do documento do cliente informado, é possível usar a ação HTTP Request para buscar dados da fatura do cliente e apresentar uma mensagem com os dados das faturas abertas.

Neste caso de uso, será utilizada a ação HTTP Request com o seguinte comando. 

curl -X 'GET' 
\  'https://apicore.empresa.com.br/api/NG/NGCliente/lista-extratos?documento=@documentobot' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer @token'

As variáveis utilizadas neste exemplo são @documentobot e @token. 

3. Observe que no fluxo do bot a ação HTTP Request (1) necessita da criação de dois contexto, um irá tratar a apresentação das "Faturas localizadas" (2) e o outro contexto "Não localizou faturas" (3) para tratar a situação em que a ação não retorna nenhum boleto.


3. Tendo sucesso na execução da ação HTTP Request, a ação retornará variáveis, contendo informações sobre as faturas do cliente organizadas dentro de um JSON. Para que todas as informações contidas no JSON sejam apresentadas deve ser inserida no fluxo uma ação de Looping que irá percorrer todas as posições do JSON, repetindo o texto da mensagem com as informações de faturas.

No contexto de localizar faturas, será inserida uma ação de "Looping"(1) que irá apresentar os dados das faturas localizadas. Finalizada a repetição do looping o fluxo segue a execução de outras ações conectadas ao "Novo contexto" (2).

4. A ação Looping (1), será configurada com a mensagem que deve ser exibida, contendo as informações dos boletos localizados. 

5. Configure as propriedades da ação Looping com as seguintes informações:

  • Texto da mensagem: informe o texto que será apresentado junto com os dados da fatura;
  • Texto para repetir: informe o nome das variáveis que deverão ser apresentadas na mensagem. No exemplo serão repetidos dados das variáveis @caminhoDownload, @dataVencimentoFormatado e @Status;
  • Nome da variável do array: informe qual parte do JSON, que contém as variáveis que serão apresentadas;
  • Máximo de interações: informe quantas vezes a mensagem será repetida.

7. Para concluir as configurações da ação HTTP Request, crie um fluxo para o contexto onde não foram localizadas faturas.

Pronto! Agora você já sabe como configurar a ação HTTP Request com comandos de API para realizar as integrações.

Em caso de dúvidas, chame nossa equipe no chat. 😉