DocTransform
HilfeAPISchnellstart

Schnellstart

Von einem API-Schlüssel zu einer heruntergeladenen Datei in fünf Schritten.

Fünf Schritte von einem Schlüssel zu einer heruntergeladenen Datei.

Die öffentliche API führt eine Vorlage aus, die du bereits in DocTransform erstellt hast, auf einer Datei, die du per Skript hochlädst — ganz ohne Browser-Tab.

Die fünf Schritte

1

Einen Schlüssel erstellen

Klicke auf deiner Kontoseite auf Einen Schlüssel erstellen. Kopiere ihn jetzt — er wird nur einmal angezeigt.

2

Als Umgebungsvariable setzen

Jedes Beispiel auf diesen Seiten liest den Schlüssel aus DOCTRANSFORM_API_KEY, nie als Literal im Befehl:

export DOCTRANSFORM_API_KEY=dt_live_...
3

Deine Vorlagen auflisten

Finde die id der Vorlage, die du ausführen willst.

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

Einen Lauf erstellen

Lade eine Datei hoch, um diese Vorlage darauf anzuwenden.

curl -X POST "https://doctransform.xyz/api/v1/templates/tmpl_123/runs" \
  -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \
  -F "file=@/pfad/zu/deiner/datei.csv"

Nur ein Lauf, der eine Datei liefert, zählt zu deinen monatlichen Läufen.

5

Abfragen, dann herunterladen

Ein schneller Lauf antwortet sofort mit 201, das Ergebnis liegt schon bereit. Ein längerer antwortet mit 202, während er weiterarbeitet — frage GET /runs/{id} ab, bis sich sein Status klärt, und lade dann herunter:

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

Siehe Authentifizierung, Läufe und Fehler und Limits für die vollständigen Details hinter jedem Schritt.