Présentation

Envoyer des documents à Raydocs et importer le dossier et ses pièces dans votre logiciel métier.

Raydocs analyse les documents d’une demande et renvoie un dossier structuré au format CDJ Connect, accompagné des liens de téléchargement de ses pièces. Le traitement est asynchrone : le premier appel fournit un identifiant de suivi, puis votre logiciel métier reçoit une notification facultative par webhook ou consulte l’API pour récupérer le résultat une fois le traitement terminé.

Découvrez aussi notre parcours utilisateur recommandé : une intégration native avec dépôt, suivi et validation manuelle, accompagnée d’une maquette interactive.

Le parcours complet

Parcours en cas de succès, avec la notification activée sur le workflow publié. Téléchargez chaque pièce dès réception du résultat.

%%{init: {"theme":"base","themeVariables":{"primaryColor":"#f0efff","primaryTextColor":"#373064","primaryBorderColor":"#8b80ed","actorBkg":"#f0efff","actorBorder":"#8b80ed","actorTextColor":"#373064","actorLineColor":"#ddd9ee","signalColor":"#7564cf","signalTextColor":"#373064","labelBoxBkgColor":"#faf9ff","labelBoxBorderColor":"#ddd9ee","labelTextColor":"#7564cf","loopTextColor":"#7564cf","noteBkgColor":"#f0efff","noteBorderColor":"#ddd9ee","noteTextColor":"#373064","fontFamily":"Inter, sans-serif","fontSize":"14px"},"sequence":{"mirrorActors":false,"actorMargin":80,"messageMargin":24,"diagramMarginY":12,"width":160,"height":44}}}%%
sequenceDiagram
  participant LM as Logiciel métier
  participant API as API Raydocs
  LM->>API: Envoyer les fichiers + notification_url
  API-->>LM: 202 · RUN_ID
  API->>LM: Notification · JSON + download_url
  LM-->>API: Accusé de réception · 2xx
  LM->>API: Télécharger via download_url · sans token
  API-->>LM: Pièce

Si les notifications ne sont pas envisageables ou si votre logiciel métier ne peut pas recevoir de webhook, utilisez le . Il permet aussi de reprendre le suivi lorsqu’une notification attendue n’arrive pas.

Avant de commencer

Raydocs vous fournit un workflow configuré, son URL de déclenchement et un token dédié. Un workflow est le traitement configuré ; un run est une exécution de ce traitement pour une demande.

Valeur	Utilisation
`BASE_URL`	URL de base : `https://api.raydocs.com`.
`WEBHOOK_URL`	URL fournie : `https://api.raydocs.com/webhooks/workflows/{WEBHOOK_PUBLIC_UUID}`.
`WORKSPACE_ID`	Identifiant de votre espace de travail.
`WORKFLOW_ID`	Identifiant du workflow configuré.
`RAYDOCS_API_TOKEN`	Token à utiliser côté serveur pour les appels API.

Conservez le RUN_ID retourné à l’envoi. Les file_id du résultat identifient les fichiers ; ils sont distincts des références métier des pièces.

Vous pouvez aussi associer le client à la demande grâce aux métadonnées de suivi. Le champ client_id est facultatif, transmis comme chaîne dans _raydocs.metadata, séparément du contenu métier.

Choisir le suivi de la demande

Avec notification par webhook : l’option est configurée sur le workflow d’intégration publié ; ajoutez notification_url à l’envoi. Raydocs transmet le résultat complet ou l’erreur à votre logiciel métier. Consultez les notifications de fin de traitement pour sécuriser la réception, répondre en 2xx et dédupliquer avec run_id.
Par polling : si notification_url est absente, vide ou composée uniquement d’espaces, consultez le statut puis récupérez le résultat. Ce parcours reste aussi la solution de reprise si aucune notification n’arrive.

Dans les deux cas, un succès fournit le JSON CDJ Connect et les download_url des pièces. Téléchargez directement les fichiers dès réception. Le statut de notification success correspond au statut API completed ; il ne confirme pas encore l’import dans le logiciel métier.

Les appels API

Méthode	Appel	Rôle
POST	Envoyer les documents	Créer un traitement à partir des fichiers d’une même demande.
GET	Consulter le statut	Suivre le traitement jusqu’à sa fin.
GET	Récupérer le résultat	Obtenir le JSON métier et les liens des fichiers disponibles.
GET	Obtenir un lien de téléchargement	Obtenir ou renouveler le lien d’un fichier, si nécessaire.

Consultez l’authentification avant votre premier appel, puis les bonnes pratiques pour gérer les reprises et les erreurs.

Format et transport

Le standard CDJ Connect définit les données métier du dossier. Cette API Raydocs définit leur transport : elle livre un JSON et des fichiers individuels, sans générer de ZIP de résultat.

file_id, file_expires_at, download_url et download_url_expires_at relèvent de la convention API Raydocs. Ils ne sont pas des champs standard CDJ Connect 1.2. Dans ce parcours, chemin indique où enregistrer la pièce localement ; dans le standard, il désigne son chemin dans le ZIP.

Le champ notification_url et l’enveloppe de notification run_id / status / output sont également propres au transport Raydocs. Seul output contient le résultat CDJ Connect : cette enveloppe ne fait pas partie du schéma métier et n’est pas imposée aux autres échanges CDJ Connect.

Dans cette rubrique

Une intégration pensée pour le collaborateur Authentification Envoyer les documents Consulter le statut Récupérer le résultat Obtenir un lien de téléchargement Notifications de fin de traitement Métadonnées de suivi Bonnes pratiques et gestion des erreurs