Aller au contenu
Documentation

Créer un parcours sans modèle

Décrire en une seule requête les documents et les participants d'un parcours, sans modèle préparé dans l'application.

2 min de lecture Mise à jour le 9 novembre 2026

Sans modèle, la clé Transaction décrit le parcours entier — son nom, ses documents, ses participants —, et les autres clés du formulaire leur donnent leur contenu, sous leur identifiant convivial. La requête est POST https://staging-api.docage.com/Transactions/CreateFullTransaction, en multipart/form-data :

cURL
curl -X POST "https://staging-api.docage.com/Transactions/CreateFullTransaction" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -F 'Transaction={"Name":"Contrat avec Atelier Lumière","TransactionFiles":[{"FriendlyName":"Contrat","Name":"Contrat de prestation"}],"TransactionMembers":[{"FriendlyName":"Client","MemberRole":0,"SignMode":1}]}' \
  -F "Client=00000000-0000-4000-8000-000000000201" \
  -F "Contrat=@contrat-atelier-lumiere.pdf;type=application/pdf" \
  -F 'Client,Contrat={"Pages":"-1","Coordinates":"320,90,180,100"}'

Les clés du formulaire

Clé Valeur
Transaction Le parcours, en JSON : son Name, ses documents (TransactionFiles, chacun avec son FriendlyName, son Name et son Type), ses participants (TransactionMembers, chacun avec son FriendlyName, son MemberRole et son SignMode), au besoin ses observateurs (TransactionObservers).
L'identifiant convivial d'un participant (Client) La personne : l'identifiant d'un contact ou d'un utilisateur, ou un contact en JSON.
L'identifiant convivial d'un document (Contrat) Le fichier : un PDF, une image ou un document Word (.docx), converti en PDF.
« participant,document » (Client,Contrat) L'emplacement de sa signature sur ce document, en JSON.

Ajoutez ?launchTransaction=false à l'adresse pour créer le parcours en brouillon ; sans lui, il est envoyé aussitôt.

Ce que chaque participant fait : MemberRole

Donnez toujours MemberRole à un participant : 0 il signe, 1 il valide, 2 il observe. Sans lui, le participant n'a aucune action : si aucun participant n'en a, l'envoi est refusé (« Le parcours a un participant avec aucune action à effectuer ») ; sinon il est tenu pour quitte dès l'envoi, et ne signe rien. La version précédente de l'API faisait de tout participant un signataire d'office.

Un document au moins doit être à signer (Type 0, la valeur d'office ; 1 est une annexe), même pour un parcours qui ne fait que valider.

La réponse

200 rend le parcours entier, en JSON, avec ses identifiants : ceux du parcours, de ses participants (TransactionMembers[].Id), de ses documents (TransactionFiles[].Id) et de ses emplacements de signature (TransactionFields). Un envoi refusé répond 400 — « Le parcours a été enregistré en brouillon, mais son envoi est refusé (identifiant) : … » — : corrigez le brouillon et lancez-le par POST https://staging-api.docage.com/Transactions/LaunchTransaction/{id}.

Les règles communes

  • Le parcours naît dans l'organisation de l'utilisateur authentifié.
  • Un document prend le nom du fichier envoyé, sans son extension ; "KeepFileNameDuringReplacement":true dans son entrée lui garde son Name.
  • Les identifiants conviviaux se comparent à la lettre, majuscules comprises ; les espaces d'un identifiant de participant sont retirés.
  • Une organisation qui n'est pas encore en production crée des parcours d'essai, sans code par SMS.
  • La requête entière, fichiers compris, est limitée à 1 Gio.

Dans ce chapitre