Intégration au logiciel métier

Obtenir un lien de téléchargement

GET — Obtenir ou renouveler le lien signé d’un fichier.

GET https://api.raydocs.com/workspaces/{WORKSPACE_ID}/workflows/{WORKFLOW_ID}/runs/{RUN_ID}/file?file_id={FILE_ID}

Paramètres du chemin

ParamètreTypeObligatoireDescription
WORKSPACE_IDIdentifiantOuiEspace de travail fourni par Raydocs.
WORKFLOW_IDUUIDOuiWorkflow configuré pour votre intégration.
RUN_IDUUIDOuiIdentifiant retourné lors de l’envoi des documents.

Paramètre de requête

ParamètreTypeObligatoireDescription
file_idUUIDOuiIdentifiant du fichier référencé dans le résultat, distinct de reference_piece.

Exemple de requête

curl --fail-with-body --get "https://api.raydocs.com/workspaces/{WORKSPACE_ID}/workflows/{WORKFLOW_ID}/runs/{RUN_ID}/file"   -H "Authorization: Bearer {RAYDOCS_API_TOKEN}"   -H "Accept: application/json"   --data-urlencode "file_id={FILE_ID}"

Réponse — 200 OK

{
  "url": "https://api.raydocs.com/..."
}

Le champ url contient le nouveau lien signé, valide dix minutes. Téléchargez avec cette valeur telle quelle, sans token API et en suivant les redirections.

# DOWNLOAD_URL : valeur url retournée par /file
curl --fail --location "$DOWNLOAD_URL" --output ./decision.pdf

Un identifiant inconnu ou non accessible pour ce traitement renvoie 404. Un lien renouvelé ne garantit pas qu’un fichier existe encore dans le stockage.

Disponibilité temporaire et renouvellement

Les fichiers sont disponibles temporairement. Téléchargez-les et conservez-les dans votre logiciel métier dès que le traitement est completed.

  • Les fichiers finissent par expirer définitivement. Après cette expiration, ils ne sont plus téléchargeables, même en demandant un nouveau lien.
  • L'expiration du lien de téléchargement (10 minutes) et celle du fichier sont distinctes. Si le lien expire, rappeler /file avec les mêmes RUN_ID et file_id pour en obtenir un nouveau, sans relancer le workflow.
  • Demander une nouvelle URL ne prolonge pas la conservation du fichier. Un fichier supprimé n'est pas restauré par le renouvellement du lien.
  • Un identifiant de fichier inconnu pour le run entraîne une réponse 404. Le téléchargement peut également échouer si le fichier n'est plus disponible.
  • Conserver les liens confidentiels : leur signature permet l'accès au fichier pendant leur validité. Ne pas les enregistrer comme références durables. En cas d'échec de téléchargement d'une pièce, conserver le JSON, le RUN_ID, sa reference_piece et son file_id pour reprendre uniquement ce téléchargement. Un nouvel appel au webhook crée un nouveau run ; il ne doit pas servir à renouveler un lien.