Connexion API : connectez votre bot

iAdvize vous permet aujourd’hui de déployer de nouvelles capacités conversationnelles en utilisant vos sources de données (informations sur un statut de livraison, relative à un produit, à une donnée CRM, données personnalisées disponibles via des APIs...) directement dans votre stratégie d'automatisation des robots.


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 à noté que les Connexions API ont un timeout de 6s et n'accepte que les appels en https (port 443).

1. Connectez votre API

Depuis l’administration iAdvize :

  • Rendez-vous dans la rubrique Automatisation puis Connexions API.
01.png
 
  • Cliquez ensuite sur Créer une connexion.
02.png

  • 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.

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 scenario.

 

2. Définissez les informations à récupérer

  • 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
03.png

3. Renseignez l’URL

L'url doit obligatoirement commencer par “https”, après avoir sélectionné votre méthode (GET, POST ou PUT). N’oubliez pas de spécifier vos paramètres. Des variables peuvent être ajoutées dans l’URL (cf exemple ci-dessous).

dans cet exemple les paramètres sont q={city} & units=metric. L’input (ici “city”) doit être entre accolades.


04.png

4. Renseignez vos valeurs secrètes

  • Renseignez ensuite vos valeurs secrètes si vous en avez.

    05.png
Les valeurs secrètes peuvent être considérées comme un moyen de stockage de variable.
Elles sont protégées et n’apparaitront pas en clair lors des modifications ultérieures de la connexion API.

06.png

5. Renseignez vos headers

C’est ici que vous indiquerez votre clef API ainsi que de potentiels autres headers.

Exemple :

07.png

6. Démarrez votre body

Dans la partie “demander un body”, il vous est demandé d’indiquer sous format JSON, les éléments que vous souhaitez envoyer (uniquement utilisable pour les requêtes de type POST).

08.png
09.png

Dans ce scénario nous utilisons une requête de type GET et donc nous n’utiliserons pas cette section.


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.

10.png

8. Testez la connexion

  • Cliquez ensuite sur “tester la connexion” pour voir si votre requête retourne les résultats attendus.
11.png
  • 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 
12.png

 

  • Si le test est concluant, vous retrouverez votre résultat dans la partie Réponse de Json”.
  • Vous pouvez également tester vos mappings sur l’outil https://jsonpath.com/.
13.png
Les tests fait dans le simulateur sont fonctionnels et ont un impact sur l’API dans le cas des calls POST
Vous pouvez maintenant utiliser votre connexion API dans le scénario de vos bots.
Pour en savoir plus, consultez cet article.