DocTransform

Dein erster API-Lauf

Führe eine Vorlage per Skript auf einer Datei aus und lade das Ergebnis herunter.

Was du brauchst

Schritte

  1. Erstelle einen Schlüssel

    Klicke auf deiner Kontoseite auf Schlüssel erstellen. Kopiere ihn jetzt: Er wird nur einmal angezeigt.

  2. Speichere ihn als Umgebungsvariable

    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. Liste deine Vorlagen auf

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

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

    Lade eine Datei hoch, um diese Vorlage darauf auszuführen.

    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"

    Nur ein Lauf, der eine Datei liefert, verbraucht einen deiner monatlichen Exporte.

  5. Frage den Status ab

    Ein schneller Lauf antwortet mit 201 und angehängtem Ergebnis. Ein längerer antwortet mit 202: Frage GET /runs/{id} ab, bis sein Status nicht mehr running ist.

    curl "https://doctransform.xyz/api/v1/runs/run_abc" \
      -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"
  6. Lade das Ergebnis herunter

    Sobald der Lauf erfolgreich war, lade seine Ausgabe herunter:

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

Nächste Schritte