Recentemente, atualizamos nossa marca em nossas ofertas e mudamos os nomes de nossos planos de preços. Se você se inscreveu antes de 9 de agosto de 2021, clique em Planos anteriores para ver os planos aplicáveis.
 Garantimos que essa alteração não afetará sua experiência com o produto e nenhuma ação é necessária de sua parte.

Você pode fazer chamadas API extensivas para qualquer sistema externo para buscar ou enviar dados e exibir os dados para o seu cliente enquanto ele interage com o bot. Você pode configurá-los uma vez na biblioteca de API e reutilizá-los em qualquer uma de suas caixas de diálogo nesse bot.


ÍNDICE


Um guia rápido para criar uma nova API:


  • Navegue até Fluxos> Configurar> Biblioteca de API
  • O botão + Nova API permitirá que você configure uma nova chamada de API



Configurando a API

  • Nome : Dê à sua chamada de API um nome adequado.


  • URL / nome da função JS: forneça o URL do endpoint aqui. A opção do seletor de conteúdo [+] neste campo permitirá que você anexe valores de espaço reservado, como entrada do cliente, outras respostas da API, parâmetros padrão, etc.


  • Método: configure o tipo de chamada de API que você deseja fazer - GET, PUT, POST, DELETE ou uma função JS e, em seguida, passe a carga útil de acordo. Por exemplo, para criar um tíquete em sua conta Freshdesk, passe o e-mail, prioridade, status, assunto e descrição em JSON. Você também pode usar marcadores de posição usando o ícone + no canto inferior direito.


  • Adicionar cabeçalhos: você pode autorizar suas APIs neste campo e também passar quaisquer parâmetros adicionais como cabeçalhos nesta seção.



  • Teste: para certificar-se de que configurou corretamente a chamada de API, você pode realizar uma execução de teste de amostra marcando a caixa de seleção Executar teste, passar os valores de teste para os campos dinâmicos configurados na carga útil (para os métodos PUT, POST e JSON ) e verifique os cabeçalhos de resposta.




  • Adicione os parâmetros de resposta necessários: Você pode fazer referência a quaisquer atributos dos cabeçalhos de resposta de qualquer caixa de diálogo do bot. Por exemplo, se você deseja exibir o ID do ticket depois de criado, o campo ID do cabeçalho pode ser adicionado a esse campo e usado nas caixas de diálogo subsequentes.


     Se uma matriz de elementos for necessária, coloque colchetes nesse campo. Por exemplo:
    data []. id , data []. name



    Para um elemento específico em uma matriz, o uso do número de índice exibirá o valor correspondente nesse campo: data [1] .id mostrará o segundo valor no campo, do exemplo acima: 60002


Página de lista de API:

Você pode acessar a biblioteca API em Flows> Configure> API library. Nesta página, você pode ver a lista de APIs que configurou. Além disso, a página também:

  • Permite pesquisar as APIs que você configurou
  • Mostra o tipo de ações configuradas para a API realizar (GET, POST, etc.)
  • Exibe quando você criou a API e quando ela foi modificada pela última vez.


Você pode editar ou excluir cada API - ou criar uma nova API a partir desta página.



Um guia rápido para usar as APIs

Você pode adicionar uma resposta da API por meio de uma mensagem, ação ou até mesmo usando uma condição.


  • Usando Message para adicionar uma resposta de API:
    Digite a mensagem ou pergunta a ser exibida ao cliente. Clique em +   ícone para acessar os espaços reservados. Nesse caso, escolha APIs. Você verá a lista de todas as APIs configuradas na biblioteca de API desse bot. Escolha a API necessária para anexá-la à caixa de texto.

    Por exemplo: se você estiver criando um tíquete para a interação do cliente com a conversa do bot, pode configurar uma chamada de API de criação de tíquete. Você pode então fazer referência ao ID do tíquete nos parâmetros de resposta.



  • Em Ações:
    Crie uma nova ação na caixa de diálogo, defina o tipo de ação para Trigger API e selecione a API necessária na lista de todas as APIs configuradas na biblioteca de API desse bot.


    Você pode inserir a ação Trigger API em qualquer lugar do fluxo. Se você precisar acionar a API antes de uma mensagem, crie a ação Trigger API antes dela. Da mesma forma, se você precisar acionar a API após uma mensagem, crie a ação Trigger API depois dela.



  • Sob condições:
    Abra a guia Condições da caixa de diálogo necessária> clique no ícone + para acessar os espaços reservados> escolha APIs no menu suspenso. Você verá a lista de todas as APIs configuradas na biblioteca de API desse bot. Selecione a chamada de API necessária e prossiga para escolher o valor da resposta. Você pode usar a resposta da API no corpo da condição e na seção de valor da condição.


    Por exemplo: no caso de um fluxo de assinatura simples, você pode obter o status do pagamento da     resposta da API e redirecionar os clientes para uma caixa de diálogo / fluxo diferente se o status não for pago ou configurar uma caixa de diálogo para exibir uma mensagem simples para os clientes se o status for igual a pago.


Coisas a serem observadas:

  • apenas APIs REST com resposta JSON são suportadas.
  • As solicitações de API expirarão após 10 segundos se uma resposta não for recebida.