L’étape Effectuer un appel API permet à un bot de conversation d’obtenir des données d’un système externe comme Shopify ou Salesforce.
Dans cette recette, vous créerez une réponse de bot pour récupérer des données météorologiques pour un lieu fourni par l’utilisateur final. La réponse obtient les données de l’API OpenWeather. Vous pouvez utiliser le workflow de réponse créé dans cette recette comme point de départ pour vos propres réponses alimentées par l’API.
- Tâche 1 : vérification de votre configuration
- Tâche 2 : création de la connexion d’API
- Tâche 3 : création d’un champ de ticket personnalisé
- Tâche 4 : création d’une réponse de bot
- Tâche 5 : test de vos modifications
Tâche 1 : vérification de votre configuration
Pour suivre cette recette, vous avez besoin des choses suivantes :
- Un compte Zendesk avec un bot de conversation publié. Si vous le souhaitez, vous pouvez utiliser un environnement de test de type sandbox pour tester le bot de conversation avant de l’utiliser dans votre environnement de production.
Pour configurer un bot de conversation pour un canal de messagerie Web ou mobile, consultez Création d’un bot de conversation pour vos canaux Web et mobiles. Pour en savoir plus sur l’utilisation de la messagerie dans un environnement de sandbox, consultez Utilisation de la messagerie dans votre sandbox.
- Une clé API pour un compte OpenWeather. L’API utilisée dans cette recette est disponible dans l’édition gratuite d’OpenWeather.
Pour vous inscrire pour un compte OpenWeather gratuit, rendez-vous sur la page de création d’un nouveau compte sur openweathermap.org. Une fois inscrit, vous pouvez obtenir une clé API sur la page de votre compte OpenWeather.
Pour activer les clés API OpenWeather, vous devez vérifier l’adresse e-mail de votre compte. Après la vérification, l’activation des clés API peut prendre jusqu’à deux heures. Pour en savoir plus, consultez les FAQ sur openweathermap.org.
Tâche 2 : création de la connexion d’API
Pour commencer, créez une connexion d’API pour stocker votre clé API OpenWeather. Votre bot de conversation peut utiliser cette connexion pour authentifier les appels à l’API OpenWeather.
- Dans le Centre d’administration, cliquez sur l’icône Applications et intégrations
dans la barre latérale, puis sélectionnez Connexions > Connexions. - Cliquez sur Créer une connexion.
- Sélectionnez le type d’authentification Clé API.
- Saisissez openweather_api_key comme nom de connexion.
- Saisissez x-api-key comme nom d’en-tête.
- Saisissez votre clé API OpenWeather comme valeur.
- Saisissez api.openweathermap.org comme domaine autorisé.
- Cliquez sur Enregistrer pour créer la connexion.
Tâche 3 : création d’un champ de ticket personnalisé
Ensuite, créez un champ de ticket personnalisé pour capturer le lieu fourni par l’utilisateur final.
- Dans le Centre d’administration, cliquez sur Objets et règles (
) dans la barre latérale, puis sélectionnez Tickets > Champs. - Cliquez sur Ajouter un champ.
- Sélectionnez le type de champ Texte.
- Saisissez Lieu comme nom d’affichage.
- Sous Permissions, sélectionnez Les clients peuvent apporter des modifications.
- Sous Clients, saisissez Lieu comme Titre visible pour les clients.
- Cliquez sur Enregistrer.
Si votre compte utilise un seul formulaire de ticket, le nouveau champ s’affiche automatiquement dans votre formulaire de ticket. Pour savoir comment supprimer le champ, consultez Modification des formulaires de ticket.
Tâche 4 : création d’une réponse de bot
Cette section vous explique comment créer la réponse, définir son intention et ajouter des étapes pour la réponse dans le créateur de bots. Voici les différentes étapes :
- Étape 1 : création de la réponse
- Étape 2 : définition de l’intention de la réponse
- Étape 3 : ajout d’un message initial
- Étape 4 : envoi d’une demande de lieu à l’utilisateur final
- Étape 5 : obtention des données météorologiques pour le lieu
- Étape 6 : envoi d’un message sur la météo à l’utilisateur final
- Étape 7 : ajout d’un message d’échec
- Étape 8 : publication de votre bot mis à jour
Étape 1 : création de la réponse
Utilisez le créateur de bots pour créer une réponse pour votre bot de conversation.
- Dans le Centre d’administration, cliquez sur
Canaux dans la barre latérale, puis sélectionnez Agents IA et automatismes > Agents IA. - Cliquez sur Gérer les bots de conversation.
- Cliquez sur le bot de conversation avec lequel vous voulez travailler.
- Dans l’onglet Réponses, cliquez sur Créer une réponse.
Étape 2 : définition de l’intention de la réponse
Définissez l’intention de la réponse et les expressions d’apprentissage. Cela inclut les expressions et les mots utilisés pour déclencher la réponse dans une conversation.
- Dans l’onglet Réponses de la page de modification du bot, cliquez sur Créer une réponse.
- Cliquez sur Création de votre propre réponse, puis sur Suiv.
- Saisissez Obtenir la météo comme intention de la réponse.
- Sous Expressions d’apprentissage, saisissez Obtenir les prévisions météo et Obtenir la température actuelle.
- Cliquez sur Suivant.
La réponse ouvre le créateur de bots et vous pouvez y créer la réponse.
Étape 3 : ajout d’un message initial
Ajoutez une étape Envoyer un message pour demander un lieu à l’utilisateur final. C’est la première étape du workflow de réponse.
- Dans le créateur de bots, cliquez sur Ajouter une étape.
- Sous Choisissez une étape, sélectionnez Envoyer un message.
- Dans Message du bot, saisissez le texte suivant :
What location would you like to get the weather for? Include the country code. For example: "Melbourne, AU" or "San Francisco, US"
Étape 4 : envoi d’une demande de lieu à l’utilisateur final
Après le message initial, ajoutez une étape Demander des détails pour présenter un formulaire élémentaire à l’utilisateur final. Le formulaire inclut un champ pour la valeur de champ de ticket Lieu.
- Dans le créateur de bots, cliquez sur l’icône Ajouter une étape (
). - Sous Choisissez une étape, sélectionnez Demander des détails.
- Saisissez Obtenir le lieu comme nom.
- Dans Champs, tapez et sélectionnez le champ de ticket Lieu.
Étape 5 : obtention des données météorologiques pour le lieu
Ajoutez une étape Effectuer un appel API pour obtenir les données météorologiques pour le lieu à partir du point de terminaison Données météo actuelles de l’API OpenWeather.
- Dans le créateur de bots, cliquez sur Ajouter une étape.
- Sous Choisissez une étape, sélectionnez Effectuer un appel API.
- Saisissez Obtenir la météo comme nom.
- Sous Détails de l’API, saisissez
https://api.openweathermap.org/data/2.5/weather?units=metric&q=comme URL du point de terminaison. - Utilisez l’icône Ajouter une variable (
) pour ajouter la variable de champ Lieu à la valeur URL du point de terminaison.
La valeur finale de l’URL du point de terminaison devrait ressembler à ce qui suit :
- Dans Authentification, sélectionnez la connexion openweather_api.
- Pour tester la demande API, cliquez sur Effectuer un appel API.
- Sous Données test, saisissez Melbourne, AU comme Lieu.
- Cliquez sur Effectuer un appel API.
- Enregistrez les variables suivantes en utilisant leurs noms par défaut :
- main > temp
- weather > item 1 > description
Étape 6 : envoi d’un message sur la météo à l’utilisateur final
Une fois que vous avez obtenu les données météo, utilisez une étape Envoyer un message pour répondre avec un message contenant ces données.
- Dans le créateur de bots, cliquez sur Ajouter une étape sous la branche réussite de l’appel API de l’étape Obtenir la météo.
- Sous Choisissez une étape, sélectionnez Envoyer un message.
- Dans Message du bot, saisissez le texte suivant :
It's {{temp}}° C with {{description}} in - Utilisez l’icône Ajouter une variable () pour ajouter la variable de champ Lieu à la valeur Message du bot. Puis ajoutez un point (.).
La valeur Message du bot finale devrait ressembler à ce qui suit :
Étape 7 : ajout d’un message d’échec
Il est possible que la demande faite pendant l’étape Effectuer un appel API échoue. Par exemple, la demande peut inclure un lieu qui n’existe pas. Ajoutez une étape Envoyer un message à la branche Échec de l’appel API. Cette étape renvoie un message en cas d’échec de l’appel API OpenWeather.
- Dans le créateur de bots, cliquez sur Ajouter une étape sous la branche échec de l’appel API de l’étape Obtenir la météo.
- Sous Choisissez une étape, sélectionnez Envoyer un message.
- Dans Message du bot, saisissez le texte suivant :
I'm sorry. I wasn't able to get weather data for - Utilisez l’icône Ajouter une variable () pour ajouter la variable de champ Lieu à la valeur Message du bot. Puis ajoutez un point (.).
La valeur Message du bot finale devrait ressembler à ce qui suit :
Étape 8 : publication de votre bot mis à jour
Pour que la réponse soit mise à la disposition des utilisateurs, publiez le bot mis à jour.
- Cliquez sur Terminé en haut à droite du créateur de bots.
- À la page du bot, cliquez sur Publier le bot.
- Cliquez sur Publier.
Tâche 5 : test de vos modifications
Une fois vos modifications publiées, vous pouvez tester la nouvelle réponse en demandant « Quel temps fait-il ? » dans une conversation avec le bot mis à jour. Pour en savoir plus sur les tests des bots de conversation, consultez Test de l’expérience de messagerie des utilisateurs finaux.