Connecteurs API pour données de Chatbot en direct
Connecteurs API
Les Connecteurs API permettent à votre chatbot d'appeler des API REST externes pendant une conversation pour récupérer des données en temps réel. Utilisez-les pour rechercher des commandes, vérifier des stocks, vérifier des comptes ou extraire des données de tout service exposant une API. Le chatbot recueille les détails nécessaires auprès du Visiteur, appelle votre API, valide la réponse et présente le résultat de manière conversationnelle.
Ajouter un Connecteur API
Ouvrez votre assistant dans le Tableau de bord, développez Paramètres avancés sous les onglets principaux, sélectionnez Connecteurs API et cliquez sur Ajouter un Connecteur API. Les connecteurs API ne sont pas un Canal ni une fonction. Vous pouvez partir d'un modèle prédéfini ou créer un connecteur personnalisé de zéro.
Champs de configuration
Paramètres de base
| Champ | Description | Requis |
|---|---|---|
| Nom | Un nom descriptif pour ce connecteur (par ex. "Recherche de commande", "Vérification des stocks"). | Oui |
| URL | L'URL du Point d'Accès API (par ex. https://api.example.com/orders). | Oui |
| Méthode | Méthode HTTP : GET, POST, PUT, PATCH ou DELETE. | Oui (par défaut : GET) |
| En-têtes (JSON) | En-têtes HTTP facultatifs au format JSON (par ex. {"Authorization": "Bearer abc123", "Content-Type": "application/json"}). Doit être un JSON valide. | Non |
| Activé | Indique si ce connecteur est actif. | Oui (par défaut : Activé) |
Corps de la Requête (POST/PUT/PATCH uniquement)
| Champ | Description |
|---|---|
| Type de Contenu du Corps | Format du corps de la requête : JSON ou Form Data. |
| Modèle du Corps de la Requête | Modèle pour le corps de la requête. Utilisez des espaces réservés comme {email}, {order_id} qui correspondent à vos champs définis. |
Exemple de modèle de corps :
{
"email": "{email}",
"order_id": "{order_id}"
}
Champs
Les champs définissent les informations que le chatbot doit recueillir auprès du Visiteur avant d'appeler l'API. Chaque champ comprend :
| Propriété | Description | Requis |
|---|---|---|
| Nom du Champ | L'identifiant du champ (par ex. order_id, email). Utilisé comme espace réservé dans le corps de la requête. | Oui |
| Type | Type de données : string, number, email ou boolean. | Oui (par défaut : string) |
| Description (pour l'IA) | Explique à l'IA à quoi sert ce champ et comment le demander au Visiteur. | Non |
| Obligatoire | Indique si le Visiteur doit fournir ce champ avant l'appel de l'API. | Non |
Exemple de champs :
| Nom | Type | Description | Obligatoire |
|---|---|---|---|
order_id | string | Le numéro de commande du Client, commence généralement par ORD- | Oui |
email | L'Adresse e-mail utilisée lors de la commande | Oui |
Règles de Validation de Réponse
Les règles de validation vérifient que la réponse de l'API correspond à la saisie du Visiteur. Cela évite de renvoyer les données de la mauvaise personne ou de la mauvaise commande.
Chaque règle comprend :
| Propriété | Description |
|---|---|
| Champ d'Entrée | Le champ fourni par le Visiteur à valider (parmi vos champs définis). |
| Chemin de Réponse | Chemin vers la valeur dans la réponse de l'API (par ex. billing.email, data.order.status). Utilisez la notation par points pour les objets imbriqués. |
| Comparaison | Mode de comparaison : equals, equals (ignore case), contains ou not empty. |
| Message d'Erreur | Message affiché au Visiteur en cas d'échec de la validation (par ex. "L'Adresse e-mail ne correspond pas à nos dossiers"). |
Exemple de validation :
| Champ d'Entrée | Chemin de Réponse | Comparaison | Message d'Erreur |
|---|---|---|---|
| billing.email | equals (ignore case) | L'Adresse e-mail ne correspond pas à la commande. Veuillez vérifier et réessayer. |
Prompt
Instructions destinées à l'IA sur le moment et la manière d'utiliser ce connecteur. Ceci est essentiel pour que le chatbot sache quand déclencher l'appel API.
Exemple de prompt :
Use this connector when a customer asks about their order status, shipping
information, or delivery date. Ask for their order ID and email address before
making the API call. Present the order status, shipping method, and estimated
delivery date in a friendly format.
Comment ça marche
- Le Visiteur pose une question qui correspond au prompt du connecteur (par ex. "Où est ma commande ?")
- Le chatbot demande les champs requis (par ex. numéro de commande, Adresse e-mail)
- Le Visiteur fournit les informations
- Le chatbot appelle l'API avec les données recueillies
- Les règles de validation sont vérifiées par rapport à la réponse
- Si la validation réussit, le chatbot présente les données sous forme de conversation
Enchaîner plusieurs Connecteurs API
Vous pouvez combiner plusieurs connecteurs API pour gérer des flux de travail complexes. L'IA les enchaîne automatiquement si nécessaire.
Exemple : Authentification + Récupération de données
- Connecteur 1, "Authentifier le Client" : Appelle un point d'accès de connexion avec l'Adresse e-mail et le Mot de passe du Visiteur, puis reçoit un jeton d'authentification dans la réponse.
- Connecteur 2, "Récupérer les détails de la commande" : Utilise le jeton de la première requête pour appeler un point d'accès API protégé et récupérer les données de commande.
L'IA gère cela de manière fluide : elle détecte que le deuxième connecteur a besoin des données du premier, exécute les appels dans le bon ordre et présente le résultat final au Visiteur, le tout au sein d'un flux de conversation unique.
Pour configurer cela, paramétrez chaque connecteur séparément avec son propre point d'accès, ses champs et son prompt. Dans le prompt du deuxième connecteur, indiquez qu'il dépend des données du premier (par ex. "Utiliser le jeton d'authentification du connecteur Authentifier le Client pour appeler ce point d'accès"). L'IA orchestrera la séquence automatiquement.
Bonnes pratiques
- Rédiger des prompts clairs : le prompt est le champ le plus important, il détermine le moment où le connecteur se déclenche
- Ajouter des règles de validation : validez toujours les données sensibles pour éviter les fuites de données
- Utiliser des descriptions de champ précises : aidez l'IA à poser les bonnes questions de manière naturelle
- Tester avec des réponses API réelles : assurez-vous que le chemin de réponse correspond à la structure réelle de votre API
- Gérer les erreurs proprement : définissez des messages d'erreur explicites pour les échecs de validation
- Utiliser des en-têtes d'authentification : sécurisez systématiquement vos points d'accès API avec une authentification appropriée