Breve Visão Geral

A opção Conexões de Chamada no ActionBot permite chamar uma API externa predefinida durante uma conversa.

Ao chamar uma API, o bot pode enviar parâmetros para a API e obter parâmetros na resposta.

Por que usar esse conector?

O uso de uma API externa permite que o ActionBot se integre a vários sistemas e forneça várias opções ao criar uma conversa.

A API pode ser usada para enviar informações para uma API externa (por exemplo, abrir um ticket de TI), receber informações de uma API externa (por exemplo, obter um número de ticket) ou ambos.

Como Usar a Conexão de Chamada

Tutorial em vídeo

Confira este breve tutorial sobre como usar o ActionBot para abrir um ticket no ServiceNow.

Etapa 1: Criar uma conexão

Esta seção descreve como adicionar uma nova conexão à conta do editor do ActionBot. usar a conexão durante uma conversa será realizado na próxima etapa

1. Na seção Conexões, clique em "ADICIONAR NOVA CONEXÃO"
2. Escolha "Adicionar novo destino"

3. Defina todos os parâmetros necessários na janela de diálogo e clique em "Criar" (essa é uma etapa de configuração e esses parâmetros devem ser fornecidos pelo proprietário da API)

1. 1. Nome do destino-
      • Forneça um nome fácil de usar que será usado para identificar a conexão mais tarde no processo.
      • Você pode escolher o nome que quiser.
   2. Tipo de solicitação-
      • Pode ser GET/POST/DELETE/PUT.
      • Deve ser fornecido pelo proprietário da API.
   3. URL de destino-
      • Deve ser uma URL de API legal.
      • Deve ser fornecido pelo proprietário da API.
      • A URL de destino pode conter parâmetros de consulta dinâmicos.
      • Para criar um parâmetro de consulta dinâmica dentro de um URL de destino, coloque o valor da string entre chaves.
      • Por exemplo: https://test.api/{production}/
      • O URL de destino também pode conter variáveis BBcode, permitindo que os usuários mapeiem os parâmetros dinâmicos do URL às respostas do usuário final ou usem variáveis de ambiente compatíveis com o BBcode, como wm-data, cookies e jquery.
   4. Tipo de autorização - atualmente oferecemos suporte apenas a três tipos de autenticação
      1. Sem Autenticação - não requer nenhuma informação
      2. Bearer Token: requer um token de autenticação.
      3. Autenticação Básica- requer usuário + senha
         • Observe que a senha para autenticação básica não pode conter o símbolo de dois pontos (:).
   5. Cabeçalhos (opcional) - algumas APIs exigem ou permitem cabeçalhos
   6. Recomenda-se testar a conexão da API para garantir que todos os detalhes estejam corretos.

4. A nova conexão deve ser adicionada à lista de conexões

Etapa 2: Adicionar a ação "Chamada de Conexão" durante uma conversa

Esta seção descreverá como usar uma conexão, que foi definida na etapa anterior, durante uma conversa

1. Adicione uma nova ação.
2. Escolha o tipo de ação "Chamada de Conexão" e selecione o destino da Chamada de Conexão. O destino da conexão de chamada é o nome da conexão definida na etapa anterior

• Ao usar Chamadas de Conexão com parâmetros de consulta dinâmica, variáveis BBcode ou ambos, os usuários podem mapear as respostas do usuário final para o URL de destino como variáveis dinâmicas.
  1. Os parâmetros de consulta dinâmica e as variáveis BBcode serão exibidos abaixo da entrada Selecionar Destino de Conexão de Chamada quando o destino contiver um parâmetro de consulta dinâmica ou uma variável BBcode.
  2. Os parâmetros de consulta dinâmica listados ou as variáveis BBcode podem ser mapeadas para Elementos de Conversa no menu suspenso.
  3. 

3. Defina "Dados que a Chamada de Conexão do WalkMe envia (opcional)"

É possível enviar alguns parâmetros de conversa para a chamada de API. Em cada linha, o lado esquerdo define quais dados de conversa enviar e o lado direito definirá o nome do parâmetro que a API espera receber.

No exemplo a seguir, a API espera obter um parâmetro chamado "base" e definiremos que o valor de "base" conterá a resposta do usuário a uma pergunta anterior (neste caso, "Qual moeda?")

Clicar em "raw" permitirá a edição livre dos parâmetros nos formatos XML ou JSON.

4. Defina o mapeamento de dados de resposta (opcional)

Algumas APIs retornam uma resposta. Se a resposta estiver nos formatos XML ou JSON, é possível usar essa resposta e salvá-la em novas variáveis que podem ser usadas posteriormente na conversa

Mapeando a resposta em uma nova variável.

O usuário pode adicionar quantas variáveis quiser. Para cada variável, é necessário definir o seguinte:

• Nome- escolha um nome para a nova variável
  • Não adicione caracteres especiais aos nomes de variáveis, por exemplo, hífen, traço, dois pontos, ; , (), !*, - {} @
• Tipo- definir o tipo da nova variável. Atualmente, oferecemos suporte apenas aos tipos primitivos String/Number/Boolean/Array
• Caminho - defina o caminho na resposta JSON/XML que leva às informações desejadas. Para ajudar o usuário a definir o caminho, uma ferramenta "construtor de caminhos" foi adicionada. Ao clicar nele, o editor enviará um ping à API de destino para receber uma resposta de amostra e permitirá que o usuário navegue pela resposta de amostra para definir facilmente o caminho. Se a API exigir que um parâmetro seja enviado, o construtor de caminho solicitará o fornecimento de parâmetros de amostra............................
• Valor padrão - esse valor será armazenado na variável caso o caminho definido na resposta não leve a dados válidos.
• Valor de erro: esse valor será armazenado na variável caso a Chamada de Conexão falhe.

Etapa 3: Usando as variáveis de dados de resposta durante a conversa

Caso uma nova variável seja criada a partir dos dados de resposta, ela poderá ser usada posteriormente na conversa usando "@" nos seguintes casos:

1. Em uma mensagem - exibir a variável ao usuário como parte do texto da mensagem
2. Em uma pergunta - exiba a variável ao usuário como parte do texto da pergunta
3. Em uma pergunta de escolha - exibir a variável como parte da sugestão que será exibida ao usuário. Para uma variável do tipo matriz, cada campo da matriz será exibido como uma sugestão separada. Se a matriz contiver objetos (em vez de um único atributo para cada item), você pode definir qual atributo será exibido para o usuário e qual atributo será armazenado.
4. Em uma condição - o construtor de condições pode usar a variável como base para uma condição
5. Em um conteúdo WM (por exemplo, SWT) - ao reproduzir um conteúdo WalkMe (via ação), as variáveis podem ser usadas para os dados necessários ao conteúdo

Vídeo da Dica de Terça-feira