Créer un parcours étape par étape
Créer le parcours, puis ses documents, ses participants et ses emplacements de signature, une requête par fiche, avant de le lancer.
La création en une requête suffit presque toujours. Étape par étape, chaque fiche du parcours se crée par sa propre requête, et le parcours reste un brouillon jusqu'à son lancement : utile pour compléter un parcours déjà créé, ou quand chaque fiche vient d'un moment différent de votre traitement.
Dans l'ordre :
- Créer le parcours :
POST https://staging-api.docage.com/Transactions; - Ajouter un document :
POST https://staging-api.docage.com/TransactionFiles, enmultipart/form-data; - Ajouter un participant :
POST https://staging-api.docage.com/TransactionMembers; - Poser une signature visuelle :
POST https://staging-api.docage.com/TransactionFields; - Lancer le parcours :
POST https://staging-api.docage.com/Transactions/LaunchTransaction/{id}.
Chaque création rend l'identifiant de la fiche créée, en chaîne JSON ("cccccccc-0000-4000-8000-000000000003") : c'est lui que
désigne l'étape suivante.
Les règles communes
- Chaque fiche se crée dans l'organisation de l'utilisateur authentifié : créez le parcours et ses fiches avec un utilisateur de l'organisation où le parcours doit naître.
- Une fois le parcours lancé, ses documents, ses participants et ses emplacements ne se changent plus : ces routes répondent
409. - Un corps qui manque une valeur obligatoire répond
400, avec le détail par propriété (errors).
Dans ce chapitre
-
Créer le parcours
Créer un parcours vide, en brouillon, et en régler le nom, la durée de validité et les relances.
-
Ajouter un document
Déposer un document dans un parcours en brouillon — à signer ou en annexe —, ou y joindre un document rédigé dans Docage.
-
Ajouter un participant
Ajouter à un parcours en brouillon un participant qui signe ou valide, ou un observateur qui suit son avancement.
-
Poser une signature visuelle
Placer sur un document l'encart qui montre la signature d'un participant — sa page, sa position, sa taille.
-
Lancer le parcours
Envoyer un parcours en brouillon — ce que l'envoi vérifie, ce qu'il déclenche, et ses refus.