Les agents IA adressent des demandes HTTP serveur-à-serveur vers votre backend. Ces demandes sont initiées lorsque le chemin d’un utilisateur déclenche un nœud d’intégration dans son dialogue et que les données mappées renvoyées sont stockées et disponibles pendant la durée de la session des agents IA.
Spécifications techniques de l’API de votre backend
Types d’applications
Votre API doit avoir l’une des architectures suivantes :
- REST
- GraphQL
Réponse
Votre réponse API doit être conforme aux exigences générales suivantes :
- Fournir une réponse API sous 30 secondes
- Renvoyer au format JSON de préférence
Authentification
Du côté agents IA, nous pouvons authentifier par différentes méthodes :
- Clé API
- Token du porteur
- Token d’expiration
- Authentification de base
- OAuth 2.0
- IP autorisées/de confiance
Liste de contrôle personnel
La liste de contrôle personnel ci-après contient des questions et des informations qui vous aideront à développer une API robuste :
- L’API est-elle « recherchable » avec des données connues d’un utilisateur classique, ou avec des données transmises par votre CRM ?
- La réponse API contient-elle des données pertinentes pour votre cas d’utilisation ?
- Si votre cas d’utilisation nécessite des données de plusieurs systèmes, pouvez-vous les consolider dans une couche intermédiaire ?
- Êtes-vous informé du code de statut HTTP renvoyé par l’API (200, 400 ou 404) ?
- Que renvoie l’API si la saisie est non valide ou incorrecte ?
- Votre système définit-il une limite de débit pour l’API ?
- De combien de temps votre système a-t-il besoin pour répondre ?
Soyez prêt à fournir ce qui suit :
• Documentation : Auth, requête/corps de la demande API et schéma de réponse
• Collection Postman (éventuellement)
• Données de test pour les résultats les plus courants
Pour en savoir plus sur le plan d’intégration, lisez l’article précédent Intégration personnalisé - Préparation.