Grâce à l'intelligence augmentée connectée d'iAdvize, les bots seront en capacité de gérer les demandes de niveau 1, souvent répétitives pour permettre à vos agents de se concentrer sur des conversations à plus haute valeur, qui nécessitent leur expertise.
Il est à noter que les Connexions API ont un timeout de 10 s et n'acceptent que les appels en https. Les adresses IP internes et IPv6 sont refusées.
Avant de commencer
- Votre API renvoie ses réponses au format JSON. Une API REST comme une API GraphQL appelée en HTTP conviennent.
- Idéalement, ayez des connaissances en API ou impliquez vos développeurs dans la configuration.
Quelques exemples d’usage :
- donner au visiteur le statut de sa dernière commande à partir de son numéro de commande ;
- lui suggérer des produits tirés de votre catalogue, par exemple selon ses achats précédents ;
- lui envoyer le lien vers l’article de votre FAQ qui répond à sa question.
- Rendez-vous dans la rubrique Assistant Shopping > Connexions API.
- Cliquez ensuite sur Créer une connexion.
- Choisissez le nom que vous donnerez à votre connexion API. Comme indiqué dans l’admin, la connexion vous sera proposée sous ce nom dans le bot builder.
À chaque modification de la connexion, une nouvelle version sera générée. Il faudra donc mettre à jour la version sélectionnée dans le scénario du bot (champ « Choisissez la version » de la carte Connexion API).
Pour la suite de l’article, nous prendrons un exemple spécifique : créer un bot qui demande un nom de ville au visiteur afin de lui renvoyer la température minimale, la température maximale et l’humidité de cette ville.
Nous allons donc interroger l’API d’une app de météo.
Nous choisirons le nom “Weather” pour ce scénario.
2.
- Définissez les entrées (inputs) (=paramètres dynamiques que nous souhaitons récupérer dans la conversation de la part du visiteur que nous pourrons ensuite renseigner dans notre requête)
Les entrées (input) seront donc utilisées dans le scénario du bot par la suite - nous vous conseillons d’utiliser des intitulés facilement reconnaissables.
En cas d’ajout/modification/suppression d’input/output dans une nouvelle version, il faudra penser à mettre à jour le scénario du bot en conséquence.
- city → type = string
customData.<libellé_de_la_donnée>, par exemple customData.cust_email.
L'url doit obligatoirement commencer par “https”, après avoir sélectionné votre méthode (GET, POST, PUT, PATCH ou DELETE). N’oubliez pas de spécifier vos paramètres. Des variables peuvent être ajoutées dans l’URL (cf exemple ci-dessous).
- Renseignez ensuite vos valeurs secrètes si vous en avez.
Exemple :
Dans la partie Request body, indiquez au format JSON les éléments que vous souhaitez envoyer. Dès qu’il est renseigné, le body est envoyé avec la requête, quelle que soit la méthode choisie. Laissez-le vide si votre API n’en attend pas.
7. Définissez les données à extraire
Maintenant il faut définir les informations que nous souhaitons récupérer en sortie (mapping) avec le chemin JSON qui nous permettra de récupérer la valeur qui nous intéresse.
8. Testez la connexion
- Cliquez ensuite sur “tester la connexion” pour voir si votre requête retourne les résultats attendus.
- Entrez une valeur de test comme dans l’exemple ci-dessous :
- Ici, on vous demandera de renseigner toutes les valeurs input précédemment définies
9. En cas d’échec de la requête
Dans la carte Connexion API du scénario, activez « Alternative en cas d’échec de la requête » pour déclencher une autre action quand la requête échoue. L’alternative se déclenche notamment quand :
- l’API répond par une erreur ;
- l’API ne répond pas, ou met plus de 10 secondes à répondre ;
- la réponse n’est pas au format JSON, ou le chemin JSON configuré est introuvable ;
- la réponse du visiteur ne correspond pas au format attendu (texte, montant, durée…), après les relances.