DocTransform

Première exécution avec l'API

Exécutez un modèle sur un fichier depuis un script et téléchargez le résultat.

Ce qu'il vous faut

Étapes

  1. Créez une clé

    Depuis votre page Compte, cliquez sur Créer une clé. Copiez-la maintenant : elle ne s’affiche qu’une seule fois.

  2. Enregistrez-la comme variable d’environnement

    Chaque exemple de ces pages lit la clé dans DOCTRANSFORM_API_KEY, jamais comme un littéral dans la commande :

    export DOCTRANSFORM_API_KEY=dt_live_...
  3. Listez vos modèles

    Trouvez l’id du modèle que vous voulez exécuter.

    curl "https://doctransform.xyz/api/v1/templates" \
      -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"
  4. Créez une exécution

    Envoyez un fichier pour y exécuter ce modèle.

    curl -X POST "https://doctransform.xyz/api/v1/templates/tmpl_123/runs" \
      -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \
      -F "file=@/path/to/your/file.csv"

    Seule une exécution qui renvoie un fichier consomme une de vos exportations du mois.

  5. Consultez son statut

    Une exécution rapide répond 201 avec le résultat joint. Une plus longue répond 202 : interrogez GET /runs/{id} jusqu’à ce que son statut ne soit plus running.

    curl "https://doctransform.xyz/api/v1/runs/run_abc" \
      -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"
  6. Téléchargez le résultat

    Une fois l’exécution réussie, téléchargez sa sortie :

    curl "https://doctransform.xyz/api/v1/runs/run_abc/output" \
      -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \
      -o result.csv

Étapes suivantes