Comment configurer une intégration API personnalisée avec AI Assist

Les instructions ci-dessous s’appliquent uniquement aux ordinateurs de bureau et portables.
La fonction AI Assist de tawk.to vous permet de connecter votre chat en direct à vos systèmes internes, offrant aux clients un accès rapide aux informations produits et commandes en temps réel. Cela leur permet de consulter facilement votre inventaire, de passer et suivre des commandes, de programmer des rendez-vous, et bien plus encore.


Vous pouvez également exploiter les données clients pour personnaliser les échanges, par exemple en saluant les clients par leur prénom ou en leur suggérant des produits en fonction de leurs achats précédents.


Les intégrations API peuvent élargir les fonctionnalités de votre chat en direct, améliorer l’expérience client et alléger la charge de travail de votre équipe d’assistance.


Si vous utilisez plusieurs agents IA, ils partagent les mêmes intégrations API, ce qui garantit une diffusion cohérente et fiable des informations sur tous les canaux.


Dans ce guide, nous vous expliquons les étapes de base pour intégrer AI Assist à d’autres API à l’aide d’OpenAPI.
Préparez votre schéma OpenAPI
Vous aurez tout d’abord besoin de votre schéma OpenAPI, un fichier au format JSON (.json) ou YAML (.yaml) qui définit la communication entre l’API et AI Assist. Ce schéma contient les modèles de données de l’API, les points de terminaison, les paramètres de requête et les formats de réponse.


Assurez-vous que votre schéma utilise le format OpenAPI 3.0. Vous pouvez en savoir plus sur le format OpenAPI 3.0 ici. Cliquez ici pour un exemple de schéma OpenAPI 3.0.


Si l’API que vous souhaitez intégrer ne dispose pas encore d’une spécification OpenAPI, vous devrez peut-être en créer une. Des outils comme Postman ou Swagger Editor permettent de rédiger ces spécifications et de les valider à l’aide du Swagger Validator ou de tout autre outil en ligne.


Cliquez ici pour en savoir plus sur la création de spécifications OpenAPI.
Hébergez votre schéma OpenAPI
Ensuite, hébergez votre schéma OpenAPI sur un serveur accessible publiquement. Vous pouvez utiliser un dépôt comme GitHub, un stockage cloud tel qu’Amazon S3 ou tout autre service d’hébergement Web.


Notez l’URL de votre fichier, car vous en aurez besoin pour l’étape suivante.


Remarque : si vous mettez à jour votre fichier de schéma OpenAPI et obtenez une nouvelle URL après l’intégration, vous devrez supprimer l’intégration existante et la recréer avec la nouvelle URL.
Intégrez avec AI Assist
Suivez ces étapes pour configurer votre intégration :


1. Connectez-vous à votre compte tawk.to.


2. Dans votre tableau de bord, sélectionnez la propriété à intégrer. Passez la souris sur son nom pour vérifier que vous avez choisi la bonne.

3. Cliquez sur Les Compléments (Add-ons) dans le menu supérieur.

4. Cliquez sur Paramètres (Settings) sous AI Assist.
5. Sélectionnez votre agent IA.
6. Cliquez sur Integration/API.
7. Cliquez sur Add Tool sous API.
8. Entrez l’URL de votre fichier de spécification OpenAPI dans Schema File URL. Cette URL se trouve dans le dépôt ou le stockage hébergeant le fichier. Vérifiez que le lien est public et qu’il pointe correctement vers le fichier de spécification.


Par exemple :

https://petstore.swagger.io/v2/swagger.json


Remarque : si vous mettez à jour votre schéma OpenAPI et obtenez une nouvelle URL, vous devrez supprimer l’intégration et la recréer avec cette nouvelle URL.
9. Renseignez l’API Base URL. Il s’agit de l’URL racine de l’API, que vous pouvez obtenir auprès de son fournisseur. Les points de terminaison, requêtes et réponses définis dans votre schéma OpenAPI passeront par cette URL. Assurez-vous que vos points de terminaison correspondent à ceux de l’API pour éviter toute erreur.


Par exemple :https://petstore.swagger.io/v2
10. Choisissez la méthode d’authentification appropriée. Sélectionnez No Auth si l’API ne requiert aucune authentification.


Si vous sélectionnez API key, saisissez la clé API et sa valeur. Ces informations vous sont fournies par le fournisseur de l’API. Veillez à utiliser la bonne clé pour éviter toute erreur d’authentification.
Si vous choisissez Basic, renseignez votre nom d’utilisateur et votre mot de passe.
10. Vérifiez bien toutes les informations, puis cliquez sur Save.
Aidez AI Assist à comprendre votre intégration API
AI Assist s’appuie sur vos sources de données, y compris les intégrations API, pour répondre aux clients.


Pour aider AI Assist à comprendre votre intégration et répondre avec précision, suivez ces recommandations :


  • Assurez-vous que votre schéma API contient des descriptions détaillées des points de terminaison et des paramètres utilisés dans votre intégration.
  • Mettez à jour le Base Prompt dans la page de paramètres afin d’indiquer à AI Assist quand effectuer une requête API et quelles données récupérer. Par exemple :


- Si le client demande le statut d’une commande, exécutez [API call] pour obtenir les informations pertinentes.


Il est essentiel d’utiliser exactement le nom de la requête API tel qu’il figure dans votre schéma.


Pour en savoir plus sur la configuration du Base Prompt, cliquez ici.
À retenir
  • Vous pouvez modifier l’API Base URL, mais pas l’URL du fichier de schéma. Si vous mettez à jour ce fichier et obtenez une nouvelle URL, il faudra supprimer l’intégration et la recréer avec le nouveau lien.
  • Lorsqu’AI Assist obtient des informations via une requête API, celles-ci sont prioritaires par rapport aux autres sources et sont utilisées pour générer une réponse. Vous pouvez personnaliser cette réponse dans le Base Prompt, en définissant par exemple le ton du message ou en ajoutant des boutons cliquables.
  • Chaque requête API possède un identifiant unique et constitue un point de données distinct. Les requêtes suivantes ne tiennent pas compte des précédentes. Ainsi, chaque requête API lancée par AI Assist est indépendante des autres.
  • Les longues conversations peuvent être tronquées, et AI Assist pourrait ne pas se souvenir des informations partagées en début d’échange.
  • Testez votre intégration pour vérifier sa précision, sa latence et sa sécurité. Respectez les bonnes pratiques en matière d’authentification API et de chiffrement des données.
  • Optimisez votre intégration pour garantir une expérience fluide à vos clients. Offrez une expérience centrée sur le client, favorisant la fidélité, stimulant les ventes et renforçant la croissance de votre activité.
  • Assurez-vous que votre intégration peut gérer une augmentation du volume de chats à mesure que votre entreprise se développe.
Consultez ces guides pour découvrir des exemples d’intégration d’AI Assist avec d’autres API :Comment intégrer AI Assist avec ShopifyComment intégrer AI Assist avec WooCommerceComment intégrer AI Assist avec Picqer
Si vous avez des retours sur cet article, ou si vous avez besoin d’aide supplémentaire :


Cet article a-t-il été utile ?

8 sur 14 ont aimé cet article