Lancer le parcours
Envoyer un parcours en brouillon — ce que l'envoi vérifie, ce qu'il déclenche, et ses refus.
POST https://staging-api.docage.com/Transactions/LaunchTransaction/cccccccc-0000-4000-8000-000000000003
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…curl -X POST "https://staging-api.docage.com/Transactions/LaunchTransaction/cccccccc-0000-4000-8000-000000000003" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…"using HttpClient client = new();
using HttpRequestMessage request = new(HttpMethod.Post, "https://staging-api.docage.com/Transactions/LaunchTransaction/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/LaunchTransaction/cccccccc-0000-4000-8000-000000000003", {
method: "POST",
headers: {
Authorization: `Bearer ${token}`
}
});
const text = await response.text();
if (!response.ok) throw new Error(text);
const result = text ? JSON.parse(text) : null;200, sans corps : le parcours est en cours (GlobalStatus à 2).
Ce que l'envoi déclenche
- Les participants de la première étape reçoivent leur invitation par email ; les suivants la reçoivent quand vient leur tour. D'office, l'ordre est : le formulaire et le remplissage des documents, la vérification d'identité, la validation, la signature, le paiement.
- La date de fin est posée : l'envoi plus
DaysBeforeEndingjours, saufEndDate. - Les crédits sont consommés quand la première étape part — sauf pour un parcours d'essai, filigrané à l'envoi. Un envoi refusé, ou dont la préparation échoue (« Un problème est survenu lors de la préparation du parcours »), ne consomme rien.
Ce que l'envoi vérifie
Un manque répond 400, avec son motif ; le parcours reste en brouillon :
- au moins un document, dont un à signer (« Le parcours ne peut pas être envoyé tant qu'au moins l'un de vos documents n'est pas à signer ») ;
- au moins un participant qui a une action (« Le parcours a un participant avec aucune action à effectuer ») ;
- chaque participant a un email valide, un prénom et un nom, et un mobile pour un code par SMS ;
- aucun participant « à définir » ni document « à remplacer » ne reste ;
- chaque champ à remplir a son participant ;
- une organisation qui n'est pas encore en production n'emploie ni code par SMS ni vérification d'identité ;
- l'ordre des actions respecte la signature : une identité se vérifie avant de signer, et rien ne modifie un document après sa première signature ;
- les crédits suffisent.
Les refus
| Code | Ce qu'il dit |
|---|---|
400 |
Le motif de la vérification, ci-dessus, dans la langue de l'utilisateur — ou « Un problème est survenu lors de la préparation du parcours ». |
403 |
Vous voyez le parcours sans avoir le droit de le modifier. |
404 |
« L'entité n'existe pas » : le parcours est introuvable, ou vous ne le voyez pas. |
500 |
« Erreur lors de l'envoi du parcours. » : réessayez, puis contactez le support. |
Les pièges
- Un parcours lancé ne se modifie plus, hors son nom, ses droits et ses champs personnalisés.
- Un modèle ne se lance pas : il sert à créer des parcours.
- Ensuite : Lire le statut d'un parcours.