Intégration au logiciel métier
Consulter le statut
GET — Suivre l’exécution d’un traitement.
GET https://api.raydocs.com/workspaces/{WORKSPACE_ID}/workflows/{WORKFLOW_ID}/runs/{RUN_ID}/statusCet endpoint permet le polling et la reprise si une notification attendue n’arrive pas. Le statut API completed correspond à success dans la notification. Aucune notification n’est garantie pour une annulation manuelle.
Consulter l’état d’une demande avec le RUN_ID retourné à l’envoi. Utilisez le token API.
Pour retrouver les traitements d’un client, transmettez ses métadonnées de suivi dès l’envoi. Le filtre sur client_id est exact : "0042" et "42" sont distincts. Cet endpoint consulte toujours un run par son RUN_ID ; client_id ne le remplace pas.
Paramètres du chemin
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
WORKSPACE_ID | Identifiant | Oui | Espace de travail fourni par Raydocs. |
WORKFLOW_ID | UUID | Oui | Workflow configuré pour votre intégration. |
RUN_ID | UUID | Oui | Identifiant retourné lors de l’envoi des documents. |
Exemple de requête
curl --fail-with-body "https://api.raydocs.com/workspaces/{WORKSPACE_ID}/workflows/{WORKFLOW_ID}/runs/{RUN_ID}/status" \
-H "Authorization: Bearer {RAYDOCS_API_TOKEN}" \
-H "Accept: application/json"
Réponse — 200 OK
{
"id": "{RUN_ID}",
"status": "running",
"created_at": "2026-05-20T14:00:00.000000Z",
"started_at": "2026-05-20T14:00:02.000000Z",
"completed_at": null,
"error": null
}
Statuts possibles: pending, running, paused, completed, failed, cancelled. Un run paused est suspendu : conserver son suivi sans resoumettre la demande.
| Statut | Conduite à tenir |
|---|---|
pending | Traitement en attente : poursuivre le suivi. |
running | Traitement en cours : poursuivre le suivi. |
paused | Traitement suspendu : conserver le suivi sans resoumettre. |
completed | Récupérer le résultat. |
failed | Arrêter le suivi automatique et examiner l’erreur. |
cancelled | Arrêter le suivi automatique et conserver cet état. |
id identifie le traitement ; created_at, started_at et completed_at indiquent ses dates, avec null lorsqu’une date n’est pas encore disponible. error contient l’erreur lorsqu’elle est exposée.
Consultez le statut toutes les quelques secondes, puis espacez les appels si nécessaire. Les recommandations de reprise sont regroupées dans les bonnes pratiques.