Utiliser les connexions API dans les scénarios de bot

Une fois votre bot connecté à une API, vous êtes désormais en mesure d’intégrer cette connexion à votre scénario. Ainsi, votre bot pourra récolter ou délivrer des informations personnalisées à vos visiteurs en toute autonomie, rendant vos répondants humains plus disponibles pour des échanges plus avancés.

Votre bot peut donc utiliser cette connexion à une API de deux façons : soit pour collecter une information et l’envoyer à une API, soit au contraire pour délivrer à ses interlocuteurs une information récupérée auprès d’une API. Cet article vous explique comment intégrer ces deux usages à son scénario.

1. Collectez des données dans votre scénario de bot et envoyez-les à une connexion API

Etape 1 – Créez une carte du type "Connexion API" dans votre scénario de bot builder

  • Vous pouvez créer un nouveau bot ou éditer un bot existant

connexion_API.png

 

Étape 2 – Définir la bonne connexion API

  • Dans le champ "Sélectionner une connexion API" choisissez l’API précédemment configurée
  • Choisissez la dernière version dans le champ "choisissez la version"

type_de_connexion.png

 

Etape 3 – Configurer les entrées attendues du visiteur

  • Pour chaque entrée, écrivez une courte question que le bot posera aux visiteurs.
  • Vous pouvez cocher la case "Ne pas poser cette question si le bot connait déjà la réponse" s’il y a une probabilité que le visiteur ait fourni cette information dans une question précédente du scénario*.
  • Choisissez l’étape suivante du scénario après les réponses du visiteur et l’action alternative en cas d’échec de la requête si le bot ne fait pas de demande d’API
  • La réponse de l’utilisateur sera automatiquement envoyée à votre API conformément à la section mapping définie dans votre connexion API
  • Choisissez la prochaine carte de votre scénario et continuez à construire votre scénario comme d’habitude

entre_es.png

 

*Cette option évitera que si la question a déjà été posée lors d’une précédente connexion API ou d’une carte de question ouverte, elle soit à nouveau posée.
Il est également utile lorsque vous devez vous connecter à plusieurs API dans le même scénario de bot et qu’une carte API peut utiliser les informations déjà demandées au visiteur dans une autre carte API.

 

Veuillez noter les raisons suivantes pour lesquelles l’action alternative en cas d’échec de la requête serait activée (une liste non exhaustive).
Il n’y a pas de réponse de l'API connectée:
- API DOWN
- URL incorrectement configurée dans la connexion API
- L'API a besoin d’une clé ID

Il y a une réponse mais mal configurée dans la connexion API ou l'API client:
- Chemin JSON mal configuré dans la connexion API
- Variable vide

Un problème avec le texte du visiteur:
- Si le texte du visiteur n’est pas dans le format de réponse configuré (texte, montant d’argent, distance, durée etc. )

 

2. Livrez des données à partir d’une connexion API dans votre scénario de bot

Les étapes 1 à 3 sont exactement les mêmes que le premier cas

Etape 4 – Retournez une réponse dynamique et personnalisée à partir des résultats de l’API

  • Choisissez une carte "message riche" comme prochaine carte de votre scénario et écrivez une réponse à la question posée à l’étape 3
  • Incluez dans votre réponse une variable de l’API en cliquant sur l’icône "ajouter variable" ou en tapant simplement le symbole { pour voir un choix de variables à inclure.
  • Choisissez la prochaine carte de votre scénario et continuez à construire votre scénario comme d’habitude

exemple_statut_commande.png

 

Rappel : puisque votre connexion API fonctionne vraiment, toutes les informations que vous enverrez à une API lors de vos tests y seront ajoutés “pour de vrai” !