Remplacer un document par un fichier
Envoyer, à la place d'un document du modèle, le fichier de cet envoi — un PDF, une image ou un document Word.
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 "Contrat=@devis-atelier-lumiere.pdf;type=application/pdf"Sous l'identifiant convivial du document (Contrat) — ou sous TransactionFile[Contrat]_File —, le fichier. Il remplace le
contenu du document du modèle ; le document garde sa place, son type (à signer ou annexe) et ses emplacements de signature.
Les formats
Le format se reconnaît au contenu du fichier, pas à son nom :
| Fichier reçu | Ce qui est rangé |
|---|---|
| Un PDF | Le PDF, tel quel. |
| Une image JPEG, PNG, GIF, BMP, TIFF ou HEIC | Une page A4 qui la porte, en PDF. |
Un document Word (.docx) |
Sa conversion en PDF. |
Tout autre fichier (.doc, .xlsx, .odt, texte…) |
Refusé : 400, « Format refusé : un document de parcours s'envoie en PDF, en image ou en document Word (.docx). » |
Un fichier vide est refusé (« Le fichier est vide. »).
Les pièges
- Les emplacements de signature du modèle restent à leurs coordonnées, posées sur le document d'origine : vérifiez qu'ils tombent
au bon endroit du nouveau. Pour les déplacer, créez le parcours en brouillon, corrigez l'emplacement par
PUT https://staging-api.docage.com/TransactionFields/{id}(Pages,Coordinates), puis lancez-le. - Un emplacement envoyé par la clé
Client,Contrats'ajoute à ceux du modèle, et chacun reçoit son encart : pour en déplacer un, corrigez-le plutôt, comme ci-dessus. - Le document prend le nom du fichier envoyé, sans son extension. Pour garder le nom du modèle, ajoutez
-F 'Transaction={"TransactionFiles":[{"FriendlyName":"Contrat","KeepFileNameDuringReplacement":true}]}'. - Un document à remplacer du modèle (
IsDynamic) doit recevoir son fichier : sinon l'envoi est refusé.