Aller au contenu

Parapheurs externes

Les parapheurs externes sont des connecteurs distincts des deux parapheurs internes décrits dans Parapheur interne. Ils couvrent notamment Maarch Parapheur, Fast Parapheur, Goodflag et Ixbus.

Niveau d'exposition

L'inventaire distingue :

  • les routes privées de l'interface Maarch Courrier
  • les routes d'administration dont l'autorisation spécifique n'est pas suffisamment établie pour constituer une API intégratrice supportée
  • les callbacks d'interopérabilité configurables

La présence de ces chemins dans rest/index.php ne constitue pas une garantie d'API publique.

Maarch Parapheur

Route Consommateur et authentification Classement
GET /rest/documents/{id}/maarchParapheurWorkflow Interface Maarch Courrier, authentification REST et contrôle du périmètre Privée applicative
GET /rest/maarchParapheurOtp Interface Maarch Courrier et authentification REST Privée applicative
GET /rest/maarchParapheur/user/{id}/picture Interface Maarch Courrier et authentification REST Privée applicative

La route de workflow accepte la query string type : toute valeur différente de resource sélectionne une pièce jointe. Elle utilise l'identifiant distant conservé dans external_id et relaie le workflow retourné par le parapheur. L'OTP relaie le résultat de /rest/connectors, lorsque le service distant répond 404, Maarch Courrier retourne une liste otp vide. La photo n'est disponible que si ce connecteur est activé.

Ces routes ne sont pas publiées comme contrats intégrateurs stables.

Fast Parapheur

Route Paramètres et retour Classement
GET /rest/documents/{id}/fastParapheurWorkflow id identifie le document, retourne le workflow distant après contrôle du périmètre Privée applicative
GET /rest/fastParapheurWorkflowDetails Retourne workflowTypes, otpStatus et signatureModes Privée applicative

Ces routes sont authentifiées et consommées par l'interface. Elles ne sont pas publiées comme API intégrateur.

Ixbus

Route Paramètres et retour Classement
GET /rest/externalSignatureBook/ixbus/instance/{instanceId}/natures instanceId identifie l'instance Ixbus ; retourne ses natures Privée applicative
GET /rest/ixbus/natureDetails/{natureId}?instanceId={instanceId} Identifiants de nature et d'instance ; retourne les détails de la nature Privée applicative

Ces routes authentifiées alimentent la configuration et l'interface de sélection Ixbus. Aucun privilège d'administration propre à ces routes n'étant vérifié, elles ne sont pas publiées.

Goodflag

Inventaire

Route Usage Classement
GET /rest/documents/{id}/goodFlagWorkflow Consultation du workflow d'un document Privée applicative
GET /rest/goodflag/configuration Lecture de la configuration Administration non publiée
PUT /rest/goodflag/configuration Mise à jour de la configuration Administration non publiée
GET /rest/goodflag/templates Liste des modèles Administration non publiée
POST /rest/goodflag/templates Création d'un modèle Administration non publiée
GET /rest/goodflag/templates/{id} Consultation d'un modèle Administration non publiée
PUT /rest/goodflag/templates/{id} Modification d'un modèle Administration non publiée
DELETE /rest/goodflag/templates/{id} Suppression d'un modèle Administration non publiée
GET /rest/goodflag/consentPages Liste des pages de consentement distantes Administration non publiée
GET /rest/goodflag/signatureProfiles Liste des profils de signature distants Administration non publiée
POST /rest/goodflag/webhook Réception des événements Goodflag Callback configurable
GET /rest/goodflag/{goodflagWorkflowId}/downloadEvidenceCertificate Téléchargement d'une preuve Privée applicative

La configuration lue par l'interface contient url, usrId, groupId, options, accessTokenAlreadySet et un champ accessToken vide. Les modèles exposent notamment id, label, description, signatureProfileId et consentPageId.

Ces routes d'administration n'ont pas de contrôle de privilège. Leur publication nécessite une décision produit et sécurité.

Recevoir un événement Goodflag

POST /rest/goodflag/webhook
Content-Type: application/json

Le callback est exclu de l'authentification REST globale. L'api lit les propriétés suivantes :

Propriété Type Description
id string Identifiant du workflow Goodflag
eventType string Type de l'événement
created string Date transmise par Goodflag

Exemple anonymisé :

{
  "id": "workflow-example",
  "eventType": "workflow.completed",
  "created": "2026-08-21T10:00:00Z"
}

L'api répond 204 No Content, y compris lorsque les trois propriétés attendues ne sont pas toutes présentes.

Routes communes

Route Retour Classement
GET /rest/externalSignatureBooks/enabled enabledSignatureBook ou null Privée applicative
GET /rest/externalSummary/{resId}?limit={limit} elementsSend après contrôle du périmètre Privée applicative

Ces routes authentifiées sont utilisées par l'interface Maarch Courrier. Elles sont indépendantes du choix entre le parapheur open source et le parapheur électronique.

Pour la configuration fonctionnelle, consultez les guides d'interconnexion avec un parapheur distant.