Guide utilisateur · Administration

Connecter votre logiciel : API, jetons et webhooks

Obtenir 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. Un jeton API n'est pas généré depuis l'application : il est émis sur demande à Conformitiel (plans ouvrant l'API) pour un membre désigné du cabinet, ou par votre éditeur partenaire s'il gère votre compte. 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, dont il hérite les droits : ce membre est prévenu par e-mail, et chaque action du jeton est tracée avec son nom et celui du jeton. Demandez sa révocation 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.
  4. Pour une étude notariale dont le compte est géré par un éditeur, celui-ci peut ouvrir un dossier de vigilance en un appel avec son propre jeton partenaire (une liste de personnes, criblage compris) ; la lecture du dossier, du rapport de recherche et des fiches de vigilance se fait ensuite avec le jeton du cabinet.

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 (quatre tentatives au total : trois rejeux, une minute, dix minutes puis une heure après l'échec précédent).

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.