Remplacer un document par un modèle de document
Faire signer, à la place d'un document du modèle, un document ou un modèle de document rédigé dans Docage, rempli des données du parcours.
Un modèle de document de Docage porte des champs ({{TransactionMember[Client]_LastName}}…) que le parcours remplit avec ses
données : le nom du client, son adresse, la date… Il se désigne dans la clé Transaction, par l'identifiant convivial du document :
curl -X POST "https://staging-api.docage.com/Transactions/CreateFullTransaction" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…" \
-F "TemplateId=aaaaaaaa-0000-4000-8000-000000000001" \
-F "Client=00000000-0000-4000-8000-000000000201" \
-F 'Transaction={"TransactionFiles":[{"FriendlyName":"Contrat","InitialDocumentId":"bbbbbbbb-0000-4000-8000-000000000002"}]}'InitialDocumentId désigne un document ou un modèle de document de Docage, que vous voyez ; sinon la création est refusée
(400, « Le document référencé est introuvable »). Les identifiants des modèles de document : GET https://staging-api.docage.com/Documents/TemplatesIdAndName.
Ce qui se passe
- Au lancement, le parcours en tire son propre document : une copie du document, ou une instance du modèle.
- Ses champs se remplissent des données du parcours quand l'étape qui le signe commence : il devient alors le PDF que les participants signent.
- Avant cela, le télécharger rend un document Word (
.docx), rempli des données du moment ;format=pdfle rend en PDF.
Les pièges
- La version précédente de l'API acceptait l'identifiant du document comme valeur de la clé
Contrat: avec un modèle de parcours, cette forme n'est plus lue, et le document du modèle reste, sans erreur. - Les emplacements de signature du modèle restent à leurs coordonnées : vérifiez qu'ils tombent au bon endroit du nouveau document.
Un document rédigé dans Docage peut aussi porter la signature dans son texte, au champ
{{TransactionMember[Client]_Signature}}: l'encart s'y pose à la conversion en PDF. - Pour obtenir le document rempli sans le faire signer, voir Obtenir un document rempli depuis un modèle.