Retour aux outils et actions

Dans cet article

Accéder à l'interface de test

Lors de la visualisation ou de la modification d'un outil personnalisé, accédez à l'onglet 'Tests' dans l'interface de configuration de l'outil.

Exécuter un test d'outil

L'interface de test utilise automatiquement tous les paramètres de configuration que vous avez déjà fournis pour l'outil (URL, méthode, en-têtes, corps, authentification).

Pour tester votre outil :

  1. Vérifiez que la configuration de votre outil est complète.
  2. Cliquez sur le bouton 'Tester l'outil' dans l'onglet de test.
  3. Le système validera votre configuration d'outil avant d'envoyer la requête. Si des erreurs de configuration sont détectées, vous recevrez des avertissements de validation.

Visualiser les résultats des tests

Après l'exécution d'un test, les résultats sont affichés dans une interface à onglets avec deux vues principales :

1. Vue de la réponse :

La vue par défaut montrant les informations sur la réponse de l'API :

  • Code d'état et badge : Affiche le code d'état HTTP (par exemple, 200 OK, 401 Non autorisé) avec un badge coloré indiquant le succès ou l'échec.
  • Taille de la réponse : La taille des données renvoyées.
  • Données de réponse : Le contenu réel renvoyé par l'API, généralement formaté en JSON.
  • En-têtes de réponse : En-têtes HTTP renvoyés par l'API.

2. Vue de la requête :

Cliquez sur l'onglet 'Requête' pour voir les détails de ce qui a été envoyé à l'API :

  • URL de la requête : L'URL complète qui a été appelée, y compris les paramètres de chemin.
  • Méthode de requête : La méthode HTTP utilisée (GET, POST, etc.).
  • En-têtes de requête : Tous les en-têtes envoyés avec la requête, y compris les en-têtes d'authentification.
  • Corps de la requête : Pour les requêtes POST/PUT, la charge utile de données qui a été envoyée.

Pour les réponses volumineuses, vous pouvez cliquer sur le bouton 'Agrandir' pour afficher les données dans une boîte de dialogue plus grande pour une meilleure lisibilité.

Interpréter les résultats des tests

L'interface de test affichera le résultat de l'exécution du test, avec des indicateurs visuels clairs :

  • Succès (Vert) : Les codes d'état dans la plage 200-299 indiquent que la requête a réussi. Le corps de la réponse devrait contenir les données que vous attendiez.
  • Erreur client (Rouge) : Les codes d'état dans la plage 400-499 indiquent une erreur côté client (par exemple, 401 Non autorisé pour les problèmes d'authentification, 404 Non trouvé si la ressource n'existe pas).
  • Erreur serveur (Rouge) : Les codes d'état dans la plage 500-599 indiquent une erreur côté serveur dans l'API externe.

Examinez à la fois le code d'état et le corps de la réponse pour déterminer si votre outil fonctionne comme prévu. Pour les appels API réussis, vérifiez que la structure des données correspond à ce dont votre agent vocal aura besoin pour traiter l'information.

Résoudre les problèmes courants

Si le test échoue, examinez attentivement les résultats :

  • Erreurs d'authentification (ex. 401, 403) : Vérifiez votre configuration d'authentification dans l'onglet Authentification. Assurez-vous que la clé API, le jeton ou les identifiants sont corrects et correctement formatés.
  • Erreurs de ressource non trouvée (404) : Vérifiez que l'URL du point d'accès API est correcte. Vérifiez si les variables dans le chemin de l'URL sont correctement renseignées.
  • Erreurs de requête incorrecte (400) : Examinez la structure du corps de la requête. Assurez-vous qu'elle correspond aux exigences de l'API externe et que l'en-tête Content-Type est correctement défini, généralement sur 'application/json'.
  • Erreurs serveur (5xx) : L'API externe pourrait rencontrer des problèmes. Vérifiez son état ou réessayez plus tard.
  • Erreurs de validation : Si vous voyez des avertissements de validation avant l'exécution du test, corrigez d'abord ces problèmes de configuration.

L'onglet de vue de la requête est particulièrement utile pour le dépannage car il montre exactement ce qui a été envoyé à l'API, vous permettant de le comparer avec les exigences de la documentation de l'API.