DocTransform
AiutoAPIAvvio rapido

Avvio rapido

Da una chiave API a un file scaricato in cinque passaggi.

Cinque passaggi da una chiave a un file scaricato.

L'API pubblica esegue un modello che hai già creato in DocTransform su un file che carichi da uno script — senza nessuna scheda del browser di mezzo.

I cinque passaggi

1

Crea una chiave

Dalla tua pagina account, Crea una chiave. Copiala subito — viene mostrata una sola volta.

2

Impostala come variabile d'ambiente

Ogni esempio su 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 eseguire quel modello su di esso.

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

Solo un'esecuzione che restituisce un file conta per le tue esecuzioni mensili.

5

Interroga, poi scarica

Un'esecuzione rapida risponde subito con 201, il risultato è già pronto. Una più lunga risponde 202 mentre continua a lavorare — interroga GET /runs/{id} finché il suo stato non si stabilizza, poi scarica:

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

Vedi Autenticazione, Esecuzioni e Errori e limiti per il dettaglio completo dietro ogni passaggio.