Intégration d'API
Dans cette section, vous apprendrez à créer et gérer des API pour interagir avec des systèmes externes, récupérer des données dans des bases de connaissances et intégrer ces API de façon fluide dans les parcours conversationnels de votre bot à l'aide de l'Advanced Builder.
❗️ Cette section s'adresse aux utilisateurs historiques dont les Use Cases n'ont pas encore été migrés vers le Flow Builder. Tout nouveau Use Case doit être créé dans le Flow Builder
Présentation des API
Opérations : effectuez des actions comme récupérer des informations ou transmettre des mises à jour à des systèmes externes.
Récupération de données : récupérez des données dans les Knowledge Bases de votre bot pour enrichir les échanges.
Groupes et gestion des API
Les API sont organisées en groupes, qui servent de dossiers pour faciliter leur gestion. Vous pouvez facilement ajouter, modifier ou supprimer des groupes et les API qui y sont associées.
Actions
Dans une API, le menu en haut à droite permet de la dupliquer ou de la supprimer. La duplication vous permet de réutiliser l'API dans une autre instance de bot.
Configuration d'une API
Name : choisissez un nom explicite pour votre API afin de l'identifier facilement dans les conversations.
Linked Bot Action : indique où l'API est utilisée dans le bot.
API Group : rattachez l'API à un groupe précis.
API Type : choisissez entre External API et Knowledge Base.
URL : définissez l'URL du service ; le scripting Jinja est pris en charge pour y insérer des variables.
HTTP Method : indiquez la méthode (GET, POST, PUT, PATCH, DELETE).
Data Format : choisissez entre JSON et XML.
Caching : définissez des durées de mise en cache pour optimiser les performances.
Headers : ajoutez des en-têtes HTTP, au format JSON, avec Jinja pour un contenu dynamique.
Entrées et extractions
Inputs : définissez et nommez les variables nécessaires à l'exécution de l'API.
Extractions : isolez et exploitez les données renvoyées par l'API, à l'aide de JMESPath et du scripting Jinja pour une manipulation précise des données.
Résoudre les problèmes d'API courants
Liste blanche d'adresses IP : assurez-vous que le fournisseur de l'API a ajouté les adresses IP du backend ViaSay à sa liste blanche.
Problèmes de User-Agent : modifiez l'en-tête user-agent si l'API cible bloque les agents basés sur Python.
Temps de réponse : vérifiez que l'API répond dans des délais acceptables (4 secondes pour la connexion, 16 secondes pour la réponse complète).
Taille des réponses de l'API : maîtrisez la taille des réponses pour éviter les problèmes de performance, avec un traitement spécifique selon des seuils de taille.