Aller au contenu
AurionAI

API développeur : utilisation et webhooks

4 min de lecturePar Emmanuel Yazbeck

Les pages de l'API développeur indiquent comment les programmes utilisent l'API AurionAI et vous permettent d'envoyer des événements AurionAI vers vos propres systèmes via des webhooks.

Disponibilité : tous les profils. Administrateurs uniquement.

Prérequis

  • Vous avez le rôle Propriétaire ou Administrateur. Les autres rôles ne peuvent pas ouvrir ces pages.
  • Pour les webhooks : une adresse HTTPS de votre côté qui accepte les requêtes POST avec un corps JSON.

Ouvrir les pages de l'API développeur

  1. Dans la barre supérieure, sélectionnez votre nom ou votre photo pour ouvrir le menu utilisateur.
  2. Sélectionnez Paramètres du locataire.
  3. Accédez à la carte API Développeur.
  4. Sélectionnez Tableau de bord d'utilisation API ou Gestion des webhooks.

La carte API développeur sur la page Paramètres du tenant.

Consulter l'utilisation de l'API

La page « Tableau de bord d'utilisation de l'API » affiche le trafic de l'API AurionAI pour votre organisation.

  1. Sous « Fenêtre », choisissez « Dernier jour », « 7 derniers jours » ou « 30 derniers jours ». La valeur par défaut est sept jours.
  2. Lisez les quatre totaux : « Total des requêtes », « Taux d'erreur », « Dépassements de limite de débit » et « Succès des webhooks ».
  3. Lisez « Principaux chemins d'API » pour voir quelles adresses sont les plus appelées, avec leurs erreurs.
  4. Lisez « Tendance quotidienne » pour voir le trafic par jour.
  5. Sélectionnez « Actualiser » pour charger les derniers chiffres.

Enregistrer un webhook

  1. Sur la page « Gestion des webhooks », accédez à « Créer un abonnement ».
  2. Dans « URL cible », saisissez l'adresse HTTPS de votre récepteur.
  3. Sous « Événements », sélectionnez les événements que vous souhaitez recevoir. Les événements sont regroupés : conversations, messages, contacts, tickets, appels, base de connaissances et système.
  4. Sélectionnez « Créer le webhook ».
  5. Une boîte de dialogue affiche le secret de signature. Sélectionnez « Copier le secret » et conservez-le en lieu sûr. AurionAI ne l'affiche qu'une seule fois.
  6. Sélectionnez « J'ai sauvegardé mon secret ».

Le nouveau webhook apparaît sous « Abonnements » avec le statut « Actif ».

Vérifier la signature d'un webhook

Chaque livraison est une requête POST avec un corps JSON et les en-têtes suivants :

  • X-Webhook-Event : le nom de l'événement, par exemple ticket.created.
  • X-Webhook-Timestamp : l'heure de la livraison.
  • X-Webhook-Signature : la signature de la livraison.

Pour vérifier qu'une livraison provient d'AurionAI :

  1. Prenez la valeur de X-Webhook-Timestamp, un point, puis le corps brut de la requête, dans cet ordre.
  2. Calculez un HMAC-SHA256 de ce texte avec votre secret de signature.
  3. Écrivez le résultat en hexadécimal et comparez-le avec X-Webhook-Signature. N'acceptez la livraison que lorsqu'ils sont égaux.

Tester, mettre en pause ou supprimer un webhook

  • Sélectionnez « Envoyer un test » pour envoyer une livraison de test. Un webhook en pause ne peut pas recevoir de test.
  • Sélectionnez « Mettre en pause » pour interrompre les livraisons temporairement, et « Reprendre » pour les relancer.
  • Sélectionnez « Supprimer » et confirmez pour retirer le webhook.
  • La page liste les dernières livraisons, avec leur statut, le nombre de tentatives et le statut HTTP de votre récepteur.

Résultat

AurionAI envoie chaque événement sélectionné à votre adresse. Une livraison est considérée comme réussie lorsque votre récepteur répond avec un statut 2xx. Sinon, AurionAI réessaie ultérieurement, jusqu'à cinq tentatives au total.

En cas de problème

  • « L'URL du webhook est requise. » Saisissez l'adresse de votre récepteur.
  • « Sélectionnez au moins un événement auquel vous abonner. » Sélectionnez au moins un événement.
  • Un message indique que l'URL du webhook doit commencer par https. AurionAI envoie les webhooks uniquement vers des adresses HTTPS.
  • Un message indique que l'adresse est bloquée ou ne peut pas être résolue. AurionAI refuse les adresses privées, locales et inconnues. Utilisez une adresse publique qui se résout dans le DNS.
  • La signature ne correspond pas. Utilisez le corps brut tel que reçu, avant tout traitement. Utilisez le secret de ce webhook. Si vous avez perdu le secret, supprimez le webhook et recréez-le.
  • Les livraisons échouent. Vérifiez le statut HTTP dans la liste des livraisons. Votre récepteur doit répondre avec un statut 2xx.
  • « Aucun webhook configuré » sous « Succès des webhooks ». Votre organisation ne possède pas encore de webhook développeur.

Articles connexes

Besoin d’aide supplémentaire ? Envoyez une demande ou .