A etapa Fazer chamada de API deixa um bot de conversa usar uma solicitação REST API para obter dados de um sistema externo, como Shopify ou Salesforce.
Nessa receita, você cria uma resposta do bot que recupera dados climáticos de um local fornecido pelo usuário final. A resposta obtém dados da API OpenWeather. Você pode usar o fluxo de respostas criado nessa receita como ponto inicial para criar suas próprias respostas viabilizadas pela API.
- Tarefa 1: verificação da sua configuração
- Tarefa 2: criação de conexão de API
- Tarefa 3: criação de um campo de ticket personalizado
- Tarefa 4: criação de uma resposta de bot
- Tarefa 5: teste das alterações feitas
Tarefa 1: Verificação da sua configuração
Para completar esta receita, você precisará do seguinte:
- Uma conta do Zendesk com um bot de conversa publicado. Se quiser, você pode usar um ambiente de teste sandbox para testar o bot de conversa antes de usá-lo na produção.
Para configurar um bot de conversa em um canal de mensagens na web e em dispositivos móveis, consulte Criação de um bot de conversa para os seus canais da web e dispositivos móveis. Para informações sobre uso de mensagens em um ambiente sandbox, leia Uso das mensagens em sua sandbox.
- Uma chave de API para uma conta OpenWeather. A API usada nesta receita está disponível no plano grátis do OpenWeather.
Para cadastrar-se para uma conta OpenWeather, veja a página Criar nova conta em openweathermap.org. Após entrar, você pode obter uma chave de API na sua página da conta OpenWeather.
Para ativar as chaves da API OpenWeather, você deve verificar o endereço de e-mail da sua conta. Após a verificação, chaves de API podem levar até duas horas para ativar. Para mais informações, consulte as perguntas frequentes em openweathermap.org.
Tarefa 2: criação de conexão de API
Para começar, crie uma conexão API para armazenar a sua chave OpenWeather. O bot de conversa pode usar essa conexão para autenticar chamadas para a API OpenWeather.
- Em Central de administração, clique em
Aplicativos e integrações na barra lateral e selecione Conexões > Conexões. - Clique em Criar conexão.
- Selecione o tipo de autenticação chave da API.
- Insiraopenweather_api_key como o nome da conexão.
- Insira x-api-key como o nome do cabeçalho.
- Insira a sua chave da API OpenWeather como o Valor.
- Insira api.openweathermap.org como o domínio permitido.
- Clique em Salvar para criar a conexão.
Tarefa 3: Criação de um campo de ticket personalizado
Em seguida, crie um campo de ticket personalizado para capturar o local fornecido pelo usuário final.
- Na Central de administração, clique em
Objetos e regras na barra lateral e selecione Tickets > Campos. - Clique em Adicionar campo.
- Selecione o tipo de campo Texto.
- Digite Local como o Nome de exibição.
- Em Permissões, selecione Os clientes podem editar.
- Em Clientes, insira Local como o Título exibido para os clientes.
- Clique em Salvar.
Se sua conta usa um único formulário de ticket, o novo campo é exibido automaticamente. Para remover o campo, leia Edição de formulários de ticket.
Tarefa 4: criação de uma resposta de bot
Esta seção orienta você a criar uma resposta, configurar sua intenção e adicionar etapas para a resposta no criador de bots. Isso envolve as seguintes etapas:
- Etapa 1: criar a resposta
- Etapa 2: configurar a intenção da resposta
- Etapa 3: adicionar uma etapa de mensagem inicial
- Etapa 4: perguntar um local ao usuário final
- Etapa 5: recuperar dados de clima para o local
- Etapa 6: enviar mensagem de clima para o usuário final
- Etapa 7: adicionar uma mensagem de falha
- Etapa 8: publicar seu bot atualizado
Etapa 1: criar a resposta
Use o criador de bots para criar uma resposta para o bot de conversa.
- Na Central de administração, clique em
Canais na barra lateral e selecione Agentes de IA e automação > Agentes de IA. - Clique em Gerenciar bots de conversa.
- Clique no bot de conversa com o qual deseja trabalhar.
- Na aba Respostas, clique em Criar resposta.
Etapa 2: configurar a intenção da resposta
Configure a intenção da resposta e frases de treinamento. Essas incluem frases e palavras usadas para disparar a resposta em uma conversa.
- Na aba Respostas da página edição do bot, clique em Criar resposta.
- Clique em Crie sua própria resposta e, em seguida, em Avançar.
- Insira Obter clima como resposta para a Intenção.
- Em Frases de treinamento, insira Obter previsão do tempo e Obter temperatura atual.
- Clique em Next.
A resposta é aberta no criador de bots, onde é possível construir a resposta.
Etapa 3: adicionar uma etapa de mensagem inicial
Para perguntar o local ao usuário, adicione a etapa Enviar mensagem. Essa é a primeira etapa no fluxo da resposta.
- No criador de bots, clique em Adicionar etapa.
- Em Escolher etapa, selecione Enviar mensagem.
- Em Mensagem do bot, insira o seguinte texto:
What location would you like to get the weather for? Include the country code. For example: "Melbourne, AU" or "San Francisco, US"
Etapa 4: perguntar um local ao usuário final
Após a mensagem inicial, adicione uma etapa Pedir detalhes para apresentar um formulário básico para o usuário final. O formulário inclui uma caixa de texto para o valor Local do campo de ticket.
- No criador de bots, clique no ícone Adicionar etapa (
). - Em Escolher etapa, selecione Pedir detalhes.
- Insira Obter local como o Nome.
- Em Campos, digite e selecione Local no campo de ticket.
Etapa 5: recuperar dados de clima para o local
Adicione uma etapa Fazer chamada de API para obter dados de clima para o local a partir do ponto de extremidade Dados de clima atual.
- No criador de bots, clique em Adicionar etapa.
- Em Escolher etapa, selecione Fazer chamada de API.
- Insira Obter clima como o Nome.
- Em Detalhes da API, insira
https://api.openweathermap.org/data/2.5/weather?units=metric&q=como a URL do ponto de extremidade. - Use o ícone Adicionar uma variável (
) para incluir a variável de campo Local ao valor da URL do ponto de extremidade.
O valor final da URL do ponto de extremidade deve ser parecido com este:
- Em Autenticação, selecione a conexão openweather_api.
- Para testar a solicitação da API, clique em Fazer chamada de API.
- Em Dados de teste, insira Melbourne, AU como o Local.
- Clique em Fazer chamada de API.
- Salve as seguintes variáveis usando os seus nomes padrão:
- main > temp
- weather > item 1 > description
Etapa 6: enviar mensagem de clima para o usuário final
Após recuperar os dados de clima, use uma etapa Enviar mensagem para responder com uma mensagem contendo os dados de clima.
- No criador de bots, clique em Adicionar etapa na ramificação Êxito na chamada da API da etapa Obter clima.
- Em Escolher etapa, selecione Enviar mensagem.
- Em Mensagem do bot, insira o seguinte texto:
It's {{temp}}° C with {{description}} in - Use o ícone Adicionar uma variável () para incluir a variável de campo Local ao valor Mensagem do bot. Então adicione um ponto (.).
O valor final da Mensagem do bot deve ser parecido com este:
Etapa 7: adicionar uma mensagem de falha
A solicitação feita durante a etapa Fazer chamada de API pode falhar. Por exemplo, a solicitação pode incluir um local que não existe. Adicione uma etapa Enviar mensagem à ramificação Falha na chamada da API. Essa etapa retorna uma mensagem caso a chamada da API OpenWeather falhe.
- No criador de bots, clique em Adicionar etapa na ramificação Falha na chamada da API da etapa Obter clima.
- Em Escolher etapa, selecione Enviar mensagem.
- Em Mensagem do bot, insira o seguinte texto:
I'm sorry. I wasn't able to get weather data for - Use o ícone Adicionar uma variável () para incluir a variável de campo Local ao valor Mensagem do bot. Então adicione um ponto (.).
O valor final da Mensagem do bot deve ser parecido com este:
Etapa 8: publicar seu bot atualizado
Para ativar a resposta, publique o bot atualizado.
- Clique em Concluído no canto superior direito do criador de bots.
- Na página do bot, clique em Publicar bot.
- Clique em Publicar.
Tarefa 5: teste das alterações feitas
Depois de publicar as alterações, você pode testar a nova resposta perguntando “Como está o clima?“ em uma conversa com o bot atualizado. Para mais informações sobre como testar bots de conversa, leia Teste da experiência de mensagens do usuário final.