API personnalisée

Les actions API personnalisées permettent à votre agent d’interagir avec des services externes. Récupérez des données en temps réel, soumettez des formulaires ou déclenchez des flux de travail dans d’autres outils.

Créer une action API personnalisée

1. Accédez à l’onglet Actions de votre agent
2. Cliquez sur Ajouter une action → API personnalisée
3. Configurez l’appel API :
   • URL du point de terminaison : le point de terminaison de l’API à appeler
   • Méthode HTTP : GET, POST, PUT, PATCH ou DELETE
   • En-têtes : authentification et type de contenu
   • Corps de la requête : données à envoyer (pour POST/PUT/PATCH)
4. Enregistrez et testez

Options de configuration

URL du point de terminaison

L’URL complète du point de terminaison de l’API :

https://api.yourservice.com/v1/data

Utilisez uniquement des points de terminaison HTTPS. Les points de terminaison HTTP sont bloqués pour des raisons de sécurité.

Méthode HTTP

En-têtes

Ajoutez les en-têtes d’authentification et de type de contenu :

Authorization: Bearer {{SECRET:service_api_key}}
Content-Type: application/json

Créez le secret nommé séparément. Agentkit résout {{SECRET:name}} uniquement sur le serveur. Les lectures des actions et les journaux ne contiennent jamais la valeur stockée.

Source des données d'entrée

Pour un champ texte contenant une seule adresse e-mail, choisissez la source e-mail vérifiée avec demande si indisponible. Agentkit utilise l'adresse du contact web vérifié ou de l'expéditeur entrant. Il demande l'adresse aux visiteurs anonymes. Le modèle ne peut pas remplacer une adresse vérifiée.

Corps de la requête

Pour les requêtes POST/PUT, définissez le corps JSON avec les données que vous souhaitez envoyer.

Quand l’API est appelée

L’IA décide du moment d’appeler l’API en fonction du contexte de la conversation et de la description de l’action. Vous pouvez orienter ce comportement en fournissant une description claire du moment où l’action doit se déclencher.

Gérer les réponses

Réponse de succès

Lorsque l’API renvoie une réponse de succès (statut 2xx) :

• Affichez un message de succès au visiteur
• Incluez les données de réponse dans la conversation
• Déclenchez des actions de suivi

Gestion des erreurs

Lorsque l’API échoue :

• Affichez un message d’erreur convivial
• Consignez l’erreur pour le débogage
• Retentez éventuellement la requête

Exemples de cas d’utilisation

Vérifier le statut d’une commande

Configurez un point de terminaison GET pour récupérer les données de commande lorsque les visiteurs posent des questions sur le statut de leur commande.

Envoyer les données vers un CRM

Configurez un point de terminaison POST pour envoyer les données de prospect vers votre système CRM.

Récupérer des données en temps réel

Configurez un point de terminaison GET pour récupérer des données en temps réel (disponibilités, inventaire, etc.) depuis vos systèmes.

Considérations de sécurité

Clés API

• Stockez les clés API comme secrets nommés et référencez-les avec {{SECRET:name}}.
• Utilisez des clés spécifiques à chaque environnement pour les tests
• Faites pivoter vos clés régulièrement

Limitation du débit

• Les API externes peuvent appliquer des limites de débit
• Configurez en conséquence la limitation du débit de votre agent
• Surveillez l’utilisation de l’API dans les journaux

Confidentialité des données

• Envoyez uniquement les données nécessaires
• Assurez-vous que les services externes sont conformes au RGPD si nécessaire
• Ne consignez pas les données de réponse sensibles

Délai d’expiration et tentatives

Tester votre action API

1. Configurez l’action avec un point de terminaison de test
2. Accédez au Playground
3. Déclenchez l’action avec une saisie appropriée
4. Vérifiez la réponse dans la conversation
5. Examinez les journaux pour le débogage

Étapes suivantes

• Configurez les webhooks pour une livraison fiable
• Connectez Zapier pour des intégrations sans code
• Consultez la documentation de l’API pour les appels API entrants