Télécharger tous les documents d'un parcours
Récupérer en une archive ZIP tous les documents d'un parcours, signés et annexes.
GET https://staging-api.docage.com/Transactions/DownloadDocuments/cccccccc-0000-4000-8000-000000000003
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…curl "https://staging-api.docage.com/Transactions/DownloadDocuments/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/DownloadDocuments/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/DownloadDocuments/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;La réponse est une archive ZIP (application/zip), nommée d'après le parcours : « Contrat de prestation – Atelier Lumière.zip ».
curl -OJ "https://staging-api.docage.com/Transactions/DownloadDocuments/cccccccc-0000-4000-8000-000000000003" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…"Ce que contient l'archive
- Chaque document du parcours, dans son ordre (
Order) : les documents à signer et les annexes. - Chacun sous la forme de son téléchargement seul : le PDF une fois la signature préparée ; avant, un document rédigé
dans Docage y figure en Word (
.docx) ou en classeur (.xlsx). - Ni le fichier de preuve, ni le rapport de vérification d'identité : pour la preuve, voir Télécharger les documents et la preuve.
Deux documents du même nom sont distingués dans l'archive (« Contrat.pdf », « Contrat (2).pdf »).
Les refus
401: jeton absent ou expiré.404: le parcours est introuvable, ou vous ne le voyez pas — la réponse ne distingue pas les deux cas.400: l'archive n'a pas pu être composée ; le message dit pourquoi.
Les pièges
- La route répond dans tous les états du parcours, brouillon compris : avant la fin, les documents ne portent que les signatures déjà
faites. Attendez que le
GlobalStatusdu parcours vaille3(« Terminé »). - La version précédente de l'API rendait l'archive encodée en base64 dans un JSON : elle arrive désormais telle quelle.
- Un document illisible est omis de l'archive, sans erreur : comptez les fichiers reçus si l'exhaustivité compte.