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.
curl -X POST "https://staging-api.docage.com/TransactionFiles" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…" \
-F "TransactionId=cccccccc-0000-4000-8000-000000000003" \
-F "FileToUpload=@contrat-atelier-lumiere.pdf;type=application/pdf" \
-F "Name=Contrat de prestation" \
-F "FriendlyName=Contrat" \
-F "Type=0"La réponse est l'identifiant du document, en chaîne JSON.
Les champs du formulaire
| Champ | Valeur |
|---|---|
TransactionId |
Le parcours, en brouillon. |
FileToUpload |
Le fichier : un PDF, une image ou un document Word (.docx), converti en PDF. |
Name |
Le nom du document, obligatoire. |
FriendlyName |
Son identifiant convivial dans le parcours : celui des clés de création et des champs du texte. |
Type |
0 à signer (d'office), 1 annexe, jointe sans signature. |
InitialDocumentId |
À la place d'un fichier : un document ou un modèle de document de Docage, rempli des données du parcours à son lancement. |
Order |
Son rang parmi les documents du parcours. |
Les refus
| Code | Ce qu'il dit |
|---|---|
400 |
« Format refusé : un document de parcours s'envoie en PDF, en image ou en document Word (.docx). » |
400 |
« La propriété "FileToUpload" ou "InitialDocumentId" doit être renseignée. » |
403 |
Vous voyez le parcours sans avoir le droit de le modifier. |
404 |
« Parcours introuvable » : le parcours est introuvable, ou vous ne le voyez pas. |
404 |
« Document introuvable » : le document désigné par InitialDocumentId est introuvable, ou vous ne le voyez pas. |
409 |
« Vous ne pouvez pas modifier un parcours actif ou terminé. » |
Les pièges
- Le format se reconnaît au contenu du fichier, pas à son nom ; un fichier vide est refusé.
- Donnez un
FriendlyNamequ'aucun autre document du parcours ne porte : la création ne le vérifie pas, et c'est par lui que les emplacements de signature et les champs désignent le document. - Un fichier est limité à 1 Gio.
FileName, le champ de la version précédente, est encore lu et remplitName;TransactionDocumentIdest devenuInitialDocumentId.- Suite : Ajouter un participant.