Clés API et webhooks

Créez des clés d'accès à l'API publique Synkrone et configurez des webhooks : scopes, restriction Bridge, événements et bonnes pratiques de sécurité.

La page Administration → API permet de connecter Synkrone à vos autres outils. Elle est organisée en trois onglets : Clés API, Webhooks et Bridge.

Clés API

L’onglet Clés API gère les clés d’accès à l’API publique.

Créer une clé

  1. Cliquez sur Créer une clé
  2. Choisissez les scopes — les périmètres auxquels la clé donne accès
  3. Optionnellement, cochez Restreindre aux requêtes Bridge pour limiter l’usage de la clé
  4. Validez

⚠️ La clé n’est affichée qu’une seule fois. Le message « Clé créée — copiez-la, elle ne sera plus affichée » est explicite : copiez-la et stockez-la dans votre gestionnaire de secrets avant de fermer. Si elle est perdue, il faut en créer une nouvelle.

Bonnes pratiques

  • Une clé par intégration, pas une clé unique partagée. En cas de fuite, vous révoquez sans casser le reste.
  • Attribuez le minimum de scopes nécessaires à l’usage prévu.
  • Une clé ne se met pas dans du code déployé côté navigateur : elle donne accès à vos données métier.

Tant qu’aucune clé n’existe, la page affiche Aucune clé API.

Webhooks

L’onglet Webhooks permet de recevoir les événements Synkrone sur une URL de votre choix, plutôt que d’interroger l’API en boucle.

Créer un webhook

  1. Cliquez sur Créer un webhook
  2. Renseignez l’URL de destination
  3. Sélectionnez les Événements à recevoir
  4. Ajoutez si besoin des En-têtes HTTP (optionnel) — pratique pour un jeton d’authentification attendu par votre système

Votre endpoint doit répondre rapidement : traitez l’événement de façon asynchrone si le traitement est long.

Bridge

L’onglet Bridge concerne les accès dédiés aux échanges avec la passerelle. Les clés créées avec l’option Restreindre aux requêtes Bridge y sont rattachées.

Pour aller plus loin

Dernière mise à jour : 4 août 2026