Passer au contenu principal

API et Webhooks

Créez des tokens API et des webhooks pour connecter Klear à votre ERP, votre CRM ou vos outils.

Qui ? Administrateurs, avec l'aide d'un développeur ou d'un intégrateur.

Administration > onglet API & Webhooks.

La page a trois blocs : Tokens API, Documentation API et Webhooks.

Créer un token API

Pour qu'un outil externe lise ou écrive dans Klear :

  1. Bloc Tokens API > Créer un token.

  2. Donnez-lui un nom parlant, par exemple « Intégration Zapier ».

  3. La fenêtre Token créé avec succès affiche le token une seule fois : copiez-le tout de suite avec le bouton copier, puis transmettez-le à votre outil.

Le token a les mêmes droits que l'administrateur qui l'a créé. Chaque administrateur ne voit que ses propres tokens. La liste indique pour chacun sa date de création et sa dernière utilisation (ou « Jamais utilisé »).

⚠️ Un token donne accès à vos données : stockez-le dans votre gestionnaire de secrets et ne le partagez jamais par e-mail ou messagerie.

Révoquer ou remplacer un token

Cliquez sur la corbeille de la ligne et confirmez. C'est irréversible : les outils qui l'utilisent perdent l'accès. Pour changer de token, révoquez l'ancien, créez-en un nouveau et mettez à jour votre outil.

💡 Un administrateur quitte l'entreprise ? Révoquez ses tokens et recréez-les depuis un autre compte administrateur avant de désactiver le sien.

Documentation API

Cliquez sur Voir la documentation : une documentation interactive (Swagger) liste tous les endpoints. Un exemple d'appel est affiché directement sur la page. C'est le point d'entrée pour vos équipes techniques.

Créer un webhook

Un webhook prévient votre outil en temps réel quand un évènement se produit dans Klear.

  1. Bloc Webhooks > Créer un webhook.

  2. Nom (facultatif) et URL de destination : elle doit commencer par https.

  3. Évènements à écouter : cochez-en au moins un. Chaque catégorie a une case pour tout cocher et un compteur.

  4. Créer un webhook. La fenêtre suivante affiche le secret HMAC une seule fois : copiez-le, il permet à votre outil de vérifier que les messages viennent bien de Klear (voir le bloc Vérification de signature).

Catégorie

Évènements

Planning

Création, modification et suppression d'un évènement

Project (chantiers)

Création, modification et suppression d'un chantier

⚠️ D'autres catégories figurent dans la liste (User, Document, Timesheet) mais ne déclenchent pas encore d'envoi.

Gérer vos webhooks

Chaque ligne affiche une pastille verte (actif) ou grise (inactif), le nom, l'adresse et les évènements écoutés, puis :

  • l'interrupteur désactive le webhook sans le supprimer ;

  • Tester envoie un évènement de test et affiche « Webhook livré avec succès ! » ou « Échec de la livraison » ;

  • Régénérer le secret invalide immédiatement l'ancien secret ;

  • Voir les livraisons affiche l'historique des envois ;

  • Supprimer.

💡 Un webhook ne se modifie pas : pour changer l'adresse ou les évènements, supprimez-le et recréez-le.

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