Configurando sua biblioteca de APIs no construtor de bots

Criada por Isabelle Lemes, Modificado em Mon, 27 Feb 2023 na (o) 05:08 PM por Isabelle Lemes

Disponível apenas no plano Enterprise Omnichannel.

Você pode fazer extensas chamadas de API para qualquer sistema externo para buscar ou enviar dados e exibi-los como parte da conversa do bot. Você não precisa passar parâmetros sempre que acionar uma chamada de API a partir de uma caixa de diálogo. Em vez disso, você pode configurá-los uma vez na biblioteca da API e reutilizá-los em qualquer uma das suas caixas de diálogo.

ÍNDICE

Um guia rápido para criar uma nova API:

Vá para Bots no painel esquerdo.
Crie um novo bot ou selecione o bot que deseja editar.
Navegue até Fluxos > Configurar > Biblioteca de API

O botão + Adicionar novo permitirá que você configure uma nova chamada de API

Configurando a API

Nome : dê à sua chamada de API um nome adequado.
Nome da função URL/JS: Forneça a URL do terminal aqui. A opção do seletor de conteúdo [+] neste campo permitirá que você acrescente 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. Você também pode configurar um conteúdo de carga útil maior em um editor de texto expansível que formatará JSON automaticamente quando colado nele. Por exemplo, para criar um ticket em sua conta Freshdesk, passe o e-mail, prioridade, status, assunto e descrição em JSON. Você também pode usar espaços reservados 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 garantir que você configurou corretamente a chamada de API, você pode executar um teste de amostra marcando a caixa de seleção Executar teste , passar valores de teste para os campos dinâmicos que você configurou na carga útil (para métodos PUT, POST e JSON ) e verifique os cabeçalhos de resposta.

Adicione ou remova 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 na conversa do chatbot. Adicione ou remova os parâmetros de resposta necessários com um clique de um botão das respostas da variável de teste antes de executá-los.

Página da lista de APIs:

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

Pesquise as APIs que você já configurou
Veja o tipo de ações configuradas para a API executar (GET, POST, etc.)
Exibir quando você criou a API e quando ela foi modificada pela última vez.
Edite ou exclua cada API ou crie novas APIs.

Um guia rápido para usar as APIs

Você pode adicionar a resposta de uma 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 a pergunta a ser exibida ao cliente.
Clique no ícone + para acessar espaços reservados > APIs.
O construtor de bots exibirá a lista de todas as APIs configuradas na biblioteca de APIs.
Escolha a API necessária para anexá-la à caixa de texto.

Por exemplo: Se estiver criando um ticket para a conversa do bot, você pode configurar uma chamada de API de criação de ticket. Você pode fazer referência ao ID do ticket nos parâmetros de resposta.

Em Ações:

Crie uma nova ação na caixa de diálogo
Defina o tipo de ação como API de gatilho
Selecione a API necessária na lista de todas as APIs configuradas na biblioteca de API desse bot.
Você pode inserir a ação da API Trigger em qualquer lugar do fluxo.
Se você precisar acionar a API antes de uma mensagem, crie a ação Acionar API antes dela.
Da mesma forma, se você precisar acionar a API após uma mensagem, crie a ação Acionar API depois dela.

Sob condições:

Abra a guia Condições para a 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 APIs.
Selecione a chamada de API necessária e prossiga para escolher o valor de 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 for não pago ou configurar uma caixa de diálogo para exibir uma mensagem simples para os clientes se o status for pago.

Nota: apenas APIs REST com resposta JSON são suportadas.

Observação: as solicitações de API expirarão após 10 segundos se uma resposta não for recebida.

Por favor, escreva para freshbots-support@freshworks.com se tiver mais perguntas; ficaremos felizes em ajudá-lo.

Recentemente, atualizamos nossa marca em nossas ofertas e alteramos os nomes de nossos planos de preços. Se você se inscreveu antes de 9 de agosto de 2021, clique em Planos anteriores para visualizar seus 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.