Télécharger un document du parcours
Récupérer un seul document d'un parcours — signé, en PDF — par son identifiant.
1Trouver l'identifiant du document
Les documents d'un parcours sont dans TransactionFiles :
GET https://staging-api.docage.com/Transactions/cccccccc-0000-4000-8000-000000000003
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…curl "https://staging-api.docage.com/Transactions/cccccccc-0000-4000-8000-000000000003" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…"using HttpClient client = new();
using HttpRequestMessage request = new(HttpMethod.Get, "https://staging-api.docage.com/Transactions/cccccccc-0000-4000-8000-000000000003");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
using HttpResponseMessage response = await client.SendAsync(request);
string result = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
throw new HttpRequestException(result);const response = await fetch("https://staging-api.docage.com/Transactions/cccccccc-0000-4000-8000-000000000003", {
headers: {
Authorization: `Bearer ${token}`
}
});
const text = await response.text();
if (!response.ok) throw new Error(text);
const result = text ? JSON.parse(text) : null;Chacun a son Id, son nom (Name), son identifiant convivial (FriendlyName) et son type (Type) : 0 à signer, 1 annexe, 2
fichier de preuve, 3 rapport de vérification d'identité.
2Le télécharger
GET https://staging-api.docage.com/TransactionFiles/Download/eeeeeeee-0000-4000-8000-000000000005?format=pdf
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…curl "https://staging-api.docage.com/TransactionFiles/Download/eeeeeeee-0000-4000-8000-000000000005?format=pdf" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…"using HttpClient client = new();
using HttpRequestMessage request = new(HttpMethod.Get, "https://staging-api.docage.com/TransactionFiles/Download/eeeeeeee-0000-4000-8000-000000000005?format=pdf");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
using HttpResponseMessage response = await client.SendAsync(request);
string result = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
throw new HttpRequestException(result);const response = await fetch("https://staging-api.docage.com/TransactionFiles/Download/eeeeeeee-0000-4000-8000-000000000005?format=pdf", {
headers: {
Authorization: `Bearer ${token}`
}
});
const text = await response.text();
if (!response.ok) throw new Error(text);
const result = text ? JSON.parse(text) : null;La réponse est le fichier lui-même : 200, son type dans Content-Type, son nom dans Content-Disposition. Avec curl, -OJ
l'enregistre sous ce nom :
curl -OJ "https://staging-api.docage.com/TransactionFiles/Download/eeeeeeee-0000-4000-8000-000000000005?format=pdf" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…"Ce que vous recevez
| Le document | Ce qui est rendu |
|---|---|
| Un PDF que vous avez déposé | Le PDF, avec les signatures déjà posées. |
| Un document rédigé dans Docage, une fois sa signature préparée | Le PDF qui se signe. |
| Un document rédigé dans Docage, avant cela ou sans signature | Un document Word (.docx) — un classeur (.xlsx) pour un tableur —, rempli des données du moment ; un PDF avec format=pdf. |
format=pdf garantit un PDF dans tous les cas : sans lui, un document rédigé dans Docage peut arriver en Word.
Chaque signature réécrit le document : avant la fin du parcours, il ne porte que les signatures déjà faites. Le document final porte
toutes les signatures et le cachet du parcours ; il se reconnaît à IsSignedVersion (true) dans TransactionFiles.
Les refus
401: jeton absent ou expiré.404: le document est introuvable, ou vous ne voyez pas son parcours — la réponse ne distingue pas les deux cas.403: le rapport de vérification d'identité (Type3) est réservé au créateur du parcours.400: le téléchargement a échoué ; le message dit pourquoi.
Les pièges
- La route
TransactionFiles/DownloadDocument/{id}de la version précédente n'existe plus : elle répond404.Downloadla remplace, et rend le fichier lui-même, non plus une chaîne base64 dans un JSON. - Le document final peut encore recevoir, plus tard, sa validation à long terme (LTV) : les informations de révocation des
certificats y sont ajoutées, sans toucher aux signatures. Ses octets changent alors ; l'empreinte de la révision signée reste
celle que donne le fichier de preuve. Si vous archivez le document, téléchargez-le de nouveau quand
LtvAppliedAtUtcest renseigné. - Le fichier de preuve est aussi un document du parcours (
Type2) : cette route le télécharge, comme Télécharger le fichier de preuve.