Utilisez une API dans votre scénario de bot

Pour pousser encore plus loin l'automatisation de vos conversations et faire gagner vos clients en autonomie, vous pouvez connecter votre bot à une API, puis utiliser cette connexion et les informations dans son scénario. Un premier article vous décrit les aspects techniques et la connexion initiale à l'API. L'article ci-dessous vous détaille les possibilités d'application.

Bot & API : les applications

A ce jour, vous pouvez utiliser les API de différentes manières dans votre scénario :

  • en posant une question ouverte aux visiteurs pour collecter une information, qui sera stockée dans l'API (par exemple, en leur demandant leur adresse mail pour créer un compte client) - pour cela, utilisez la carte « connexion API »
  • dans l'autre sens, en interrogeant une API et retransmettant des informations aux visiteurs (par exemple, en donnant le statut de commande correspondant à un numéro de suivi préalablement transmis par les visiteurs). 
  • en leur présentant un choix de produits ou de services sous la forme d'un carrousel d'images et de textes sources dans l'API (par exemple, pour mettre en valeur des idées cadeaux ou produits vedettes) - pour cela, utilisez la carte « Message riche » en sélectionnant l'option « vignette ou carrousel », puis « dynamique »

Notions utiles

Une API est une ressource technique qui nécessite souvent l'intervention des développeurs pour fonctionner. Voici quelques termes pour vous repérer :

Variable 

  • une variable est une sorte de « boîte » permettant de stocker des valeurs de formes diverses (nombres, texte, images, etc),
  • au cours des échanges entre votre bot et votre API, vous pouvez créer, nommer, enregistrer ou récupérer des variables différentes,
  • pour que les échanges entre l'API et votre bot fonctionnent correctement, il est nécessaire d'utiliser rigoureusement les mêmes nomenclatures entre l'un et l'autre - par exemple, bien utiliser {email_adress} si c'est la nomenclature employée par votre API, et non {emailadress}.

Valeur ou valeur technique

  • une valeur est une donnée spécifique stockée dans une variable - par exemple, si un visiteur donne son adresse email à votre bot, celle-ci devient une valeur , stockée dans la variable {email_adress}. Cette variable peut contenir une grande quantité d'adresses email de nombreux visiteurs différents. 
  • il est possible de réemployer une valeur à différents endroits d'un scénario de bot , ce qui permet d'éviter de poser plusieurs fois la même question au fil d'une conversation - par exemple, la variable {email_adress} peut permettre de stocker l 'adresse email d'un visiteur dans votre API. Plus tard dans la conversation, le bot pourra ré-utiliser l'adresse mémorisée dans un message de type « Vous serez notifié·e de l'envoi à l'adresse email suivante {email_adress}.

Message affiché ou valeur affichée

  • les variables et les valeurs transitent entre l'API et le bot sous forme de nomenclature technique,
  • cette nomenclature n'étant pas très intuitive pour vos visiteurs, iAdvize vous permet de rédiger des messages plus compréhensibles , dans les champs intitulés « message affiché » ou « valeur affichée » des cartes de votre scénario.

Alternative en cas d'échec de la requête

  • il peut arriver qu'une requête API échoue et que vous ne puissiez pas partager d'informations avec votre API,
  • les principales raisons d'échec d'une requête vous sont détaillées dans cet article,
  • depuis chaque carte de votre scénario, vous pouvez programmer une alternative afin que votre bot puisse continuer la conversation même en cas d'échec.

Recueillez une information visiteur

Avec une question ouverte et la carte « connexion API »

Dans votre scénario de bot, créez une carte de type « connexion API »

Type-cards-Api-connection.png

Sélectionnez une API parmi celles configurées par votre équipe, puis choisissez sa dernière version. La carte va détecter automatiquement les variables configurées pour cette connexion précise.

Écrivez une question ouverte correspondant à cette variable, qui sera visible de vos visiteurs.

Vous pouvez cocher ou décocher la case « ne pas poser cette question si le bot connaît déjà la réponse » : ainsi le bot ne redemandera pas au visiteur une valeur s'il en a déjà pris connaissance plus tôt dans la conversation. 

Cards-Connection-API-FR-Check.png

Lorsque le bot et le visiteur échangeront, le bot stockera la valeur donnée par le visiteur dans la variable prévue par l'API de connexion. Choisissez ensuite l'étape suivante comme dans n'importe quelle autre carte.

N'oubliez pas de configurer une alternative au cas où la requête API échouerait ! 

Avec une question à choix multiple et la carte « QCM »

Dans votre scénario de bot, créez une carte de type « question à choix multiple » .

Choisissez un type de contenu « statique ».

Créez vos choix visiteurs.

Vous pouvez enregistrer le choix des visiteurs dans une variable pour le réutiliser dans votre scénario. 

Vous pouvez également envoyer cette variable vers une API en créant une carte « connexion API » à l'étape suivante. Pensez alors à respecter la nomenclature prévue par votre API.

MCQ_-Static-Save-variable.png

Personnalisez votre scénario avec un contenu issu d'une API

Avec la carte « contenu riche »

Dans votre scénario de bot, créez une carte de type « contenu riche »

Dans le champ de saisie, tapez le texte qui sera visible des visiteurs, puis intégrez une variable en cliquant sur l'icône « ajouter variable » ou en tapant le symbole { pour afficher la liste des variables disponibles. Pour pouvoir ajouter une variable, il vous faudra impérativement avoir créé une carte connexion API à l'étape précédente.

Choisissez ensuite l'étape suivante comme dans n'importe quelle autre carte.

Carte riche après Conex API.png

La carte « contenu riche » vous permet également d'afficher des images et contenus dynamiques depuis une API sous la forme de carrousel . Plus de détails dans cet article.

Avec la carte « question à choix multiples »

Vous pouvez également délivrer un contenu issu d'une API sous forme de QCM , par exemple pour guider vos visiteurs dans un catalogue produit.

Dans votre scénario de bot, créez une carte de type « question à choix multiple »

Choisissez un type de contenu « dynamique » - vous pouvez également saisir manuellement des choix et ainsi mélanger choix statiques et dynamiques.

Sélectionnez la valeur affichée (celle qui pourra lire vos visiteurs), la valeur technique (le code envoyé à l'API), et l'étape suivante pour chaque choix.

Vous pouvez afficher jusqu'à 13 choix, mais nous vous conseillons de restreindre votre choix pour une meilleure lisibilité. 

Vous pouvez enregistrer le choix des visiteurs dans une variable pour le réutiliser dans votre scénario. 

Vous pouvez également envoyer cette variable vers une API en créant une carte « connexion API » à l'étape suivante. Pensez alors à respecter la nomenclature prévue par votre API.