DocTransform
HilfeAPIAuthentifizierung

Authentifizierung

Bearer-API-Schlüssel, ihre Scopes, und die Fehler eines ungültigen oder zu engen Schlüssels.

Ein Bearer-Header, ein Schlüssel, kein Ablauf.

Die öffentliche API wird per Bearer-API-Schlüssel authentifiziert — es gibt kein Cookie, keinen OAuth-Flow und keinen eigenen Testmodus. Sende ihn so:

Authorization: Bearer $DOCTRANSFORM_API_KEY

Schlüssel erstellen und verwalten

dt_live_…

Jeder Schlüssel beginnt mit dt_live_. Er läuft nie von selbst ab — du behältst ihn, bis du ihn widerrufst.

Bis zu 5 aktive Schlüssel

Erstelle bis zu fünf Schlüssel pro Konto, auf deiner Kontoseite.

Ein Schlüssel trägt einen oder mehrere von drei Scopes: templates:read, runs:write und runs:read. Ein neuer Schlüssel erhält alle drei.

Einen Schlüssel rotieren

Es gibt keinen Endpunkt für eine Rotation an Ort und Stelle: erstelle zuerst den Ersatzschlüssel, stelle dein Skript darauf um, und widerrufe dann den alten von derselben Karte auf der Kontoseite.

Nie in einem Browser oder einem Repository

Nie einen Schlüssel in einem Browser oder einem Repository ablegen. Ein API-Schlüssel ist eine langlebige Zugangsdaten mit vollem Kontozugriff — bewahre ihn in einer Umgebungsvariable oder einem Secrets-Manager auf, genau wie jedes Beispiel auf diesen Seiten ihn liest:

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

Wenn die Authentifizierung fehlschlägt

StatusCodeBedeutung
401API_KEY_MISSINGEs wurde kein Bearer-Header gesendet.
401API_KEY_INVALIDDer Schlüssel ist fehlerhaft, unbekannt, widerrufen, oder das Konto ist inaktiv.
403INSUFFICIENT_SCOPEDer Schlüssel ist gültig, trägt aber nicht den Scope, den diese Operation braucht.