Guide utilisateur · Administration

Connecter votre logiciel : API, jetons et webhooks

Créer un jeton API, ce qu'il permet, recevoir les événements par webhook, lire la documentation et le journal des appels.

Sommaire
  1. Quand l'utiliser
  2. Jetons API
  3. Webhooks
  4. Accès d'un partenaire
  5. Résultat

Quand l'utiliser

Pour brancher votre logiciel métier ou celui de votre éditeur : créer des fiches, cribler, auditer et récupérer les documents sans ressaisie.

Jetons API

  1. Paramètres → API (accessible selon le plan) : Générer un jeton. Le secret n'est affiché qu'une fois ; conservez-le dans le coffre de votre logiciel.
  2. Le jeton agit au nom d'un membre du cabinet : chaque action qu'il fait est tracée avec son nom et celui du jeton. Révoquez-le dès qu'il n'est plus utilisé.
  3. La référence complète de l'API est publiée sur la page de documentation, avec des exemples.

Webhooks

  1. Paramètres → Webhooks → Ajouter : indiquez l'URL HTTPS de votre logiciel et les événements souhaités (audit terminé, criblage terminé ou correspondance détectée, fiche validée ou signée, document généré, import terminé, nouvelle correspondance en surveillance continue, signature client).
  2. Le secret affiché sert à vérifier la signature de chaque envoi. Tester envoie un événement factice.
  3. Les livraisons listent chaque envoi, son statut et les nouvelles tentatives en cas d'échec (jusqu'à quatre, espacées d'une minute à une heure).

Accès d'un partenaire

Si votre éditeur gère votre compte, Paramètres → Accès partenaire vous permet de l'autoriser à ouvrir votre espace en lecture et en préparation, jamais pour signer ni valider, et de révoquer cet accès à tout moment.

Résultat

Un échange automatisé et tracé ; le journal des appels montre exactement ce que votre logiciel a fait.

Dans l'application, ce guide s'adapte à votre profession et un lien « Aide » ouvre la bonne page depuis chaque écran. Découvrir les solutions par profession.