Passer au contenu principal

API développeur et webhooks

Créez des clés API, enregistrez des points de terminaison webhook et consultez les journaux de requêtes depuis le Centre des développeurs.

Écrit par Sarah Chen

Le Centre développeur est l'endroit où vous connectez Exayard à votre propre code et à vos propres outils. Ouvrez-le depuis Paramètres, puis Développeur. Vous y créez des clés API, enregistrez des points de terminaison de webhook et consultez un journal en direct de chaque requête API. Seuls les administrateurs de l'organisation peuvent accéder à cette page.

Clés API

Une clé API authentifie les requêtes vers l'API Exayard. Les clés appartiennent à votre organisation, le bon compte est donc sélectionné automatiquement et il n'y a pas d'identifiant d'organisation à transmettre.

Ouvrez l'onglet Clés API dans la carte Informations d'identification et cliquez sur le bouton +. Donnez un Nom à la clé, puis choisissez ses Portées. Sélectionnez Toutes pour accorder toutes les portées, ou Spécifiques pour choisir des permissions individuelles. Les portées suivent une distinction lecture/écriture par ressource, comme read:projects et write:estimates. La portée admin:org est un accès complet. Choisissez le minimum de portées dont votre intégration a besoin.

Exayard affiche la clé complète une seule fois, juste après sa création. Copiez-la à ce moment, car elle n'est plus jamais affichée. Par la suite, chaque clé apparaît avec son nom, un aperçu masqué comme ak_••••1234 et la date de sa dernière utilisation.

Utilisez l'icône de crayon pour renommer une clé ou changer ses portées. Utilisez l'icône de corbeille pour la Révoquer. La révocation est définitive et toute intégration utilisant cette clé cesse de fonctionner immédiatement.

La même clé authentifie les intégrations sans code. Consultez Connecter Exayard à Zapier, Connecter Exayard à Make et Connecter Exayard à n8n. Pour l'accès des agents et des éditeurs IA, consultez Se connecter à Claude et à d'autres outils IA.

Webhooks

Un webhook indique à Exayard d'aviser votre serveur lorsqu'un événement se produit. Ouvrez l'onglet Webhooks et cliquez sur + pour ajouter un point de terminaison. Saisissez l'URL qui doit recevoir les livraisons et une Description facultative.

Choisissez les Événements auxquels vous abonner. Sélectionnez Tous pour recevoir chaque événement, ou Spécifiques pour choisir dans la liste :

Événement

Se déclenche quand

project.created

Un projet est créé

project.updated

Un projet est modifié

project.archived

Un projet est archivé

assessment.started

Une évaluation de métré commence

assessment.completed

Une évaluation se termine

assessment.approved

Une évaluation est approuvée

assessment.cancelled

Une évaluation est annulée

estimate.generated

Une estimation est générée

bid.generated

Une soumission est générée

file.processed

Un fichier téléversé termine son traitement

Lorsque vous créez un point de terminaison, Exayard affiche un secret de signature une seule fois. Copiez-le à ce moment, car il n'est plus affiché.

Sécuriser les livraisons de webhook

Chaque livraison porte un en-tête Exayard-Signature de la forme t=<unix>,v1=<digest>. Exayard construit la signature en joignant l'horodatage et le corps de la requête, puis en les signant avec HMAC-SHA256 à l'aide du secret de votre point de terminaison.

Pour vérifier une livraison, recalculez la signature avec votre secret, confirmez que l'horodatage se situe dans les cinq minutes par rapport à maintenant, puis comparez les empreintes. Les livraisons échouées sont réessayées avec une temporisation exponentielle sur environ trois jours.

Pour modifier un point de terminaison, cliquez sur l'icône de crayon. Vous pouvez changer l'URL, la description et les événements, et régler son Statut à Actif ou En pause. Les points de terminaison en pause cessent de recevoir des livraisons. La même boîte de dialogue comporte un bouton Renouveler le secret. Le renouvellement émet un nouveau secret et l'ancien cesse de fonctionner immédiatement, alors mettez à jour votre serveur avant de renouveler. L'icône de corbeille supprime un point de terminaison et met fin à toutes les livraisons vers celui-ci.

Démarrage rapide

La carte Démarrage rapide contient une invite prête à l'emploi pour un éditeur IA comme Claude ou Cursor. Cliquez sur Copier l'invite et collez-la dans votre éditeur. L'invite inclut l'URL de base de l'API, le format d'authentification, le vocabulaire des portées et le schéma de signature des webhooks, de sorte que l'IA peut échafauder une intégration fonctionnelle et vous demander les détails dont elle a besoin.

Documentation

La carte Documentation renvoie à la documentation développeur complète et à la spécification OpenAPI, qui décrit chaque route et chaque schéma. Connecter MCP ouvre la configuration pour connecter des agents IA directement à Exayard.

Journaux

La section Journaux consigne vos requêtes API les plus récentes, tant pour l'API REST que pour MCP. Chaque rangée affiche la méthode, le chemin, le statut de réponse et la latence. Sélectionnez une rangée pour voir son détail complet, y compris l'identifiant de requête ainsi que les corps de requête et de réponse. Utilisez les journaux pour confirmer qu'un appel a fonctionné ou pour déboguer une intégration défaillante.

Avez-vous trouvé la réponse à votre question ?