DocTransform

La tua prima esecuzione con l'API

Esegui un modello su un file da uno script e scarica il risultato.

Cosa ti serve

Passaggi

  1. Crea una chiave

    Dalla tua pagina Account, premi Crea una chiave. Copiala adesso: viene mostrata una sola volta.

  2. Salvala come variabile d’ambiente

    Ogni esempio di queste pagine legge la chiave da DOCTRANSFORM_API_KEY, mai come valore letterale nel comando:

    export DOCTRANSFORM_API_KEY=dt_live_...
  3. Elenca i tuoi modelli

    Trova l’id del modello che vuoi eseguire.

    curl "https://doctransform.xyz/api/v1/templates" \
      -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"
  4. Crea un’esecuzione

    Carica un file per eseguirci sopra quel modello.

    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"

    Solo un’esecuzione che restituisce un file consuma una delle tue esportazioni del mese.

  5. Controlla il suo stato

    Un’esecuzione rapida risponde 201 con il risultato allegato. Una più lunga risponde 202: interroga GET /runs/{id} finché il suo stato non è più running.

    curl "https://doctransform.xyz/api/v1/runs/run_abc" \
      -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"
  6. Scarica il risultato

    Quando l’esecuzione è riuscita, scarica il suo output:

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

Passaggi successivi