Authentifizierung

Schulungstool nutzt API-Schlüssel, um den Zugriff auf die API zu ermöglichen. Einen API-Schlüssel können Sie in Ihrem Administrationsbereich unter Einstellungen > Erweiterte Einstellungen > Entwickleroptionen generieren.

Schulungstool erwartet den API-Schlüssel in allen API-Anfragen im HTTP-Header:

Authorization: Token <API-Schlüssel>

Bearer <API-Schlüssel> wird ebenfalls akzeptiert.

Beispiel:

curl "https://api.schulungstool.de/v1/users/" \
  -H "Authorization: Token <API-Schlüssel>"

Ersetzen Sie <API-Schlüssel> durch Ihren API-Schlüssel.

Ohne gültigen Schlüssel antwortet die API mit Statuscode 401 und dem Fehlertyp AuthenticationFailed oder NotAuthenticated, siehe Fehler und Durchsatzbegrenzung.

Direkt in der Referenz ausprobieren

In der API-Referenz können Sie jede Anfrage über Test Request direkt aus dem Browser senden. Hinterlegen Sie dazu Ihren API-Schlüssel im Feld Auth: Er bleibt ausschließlich in Ihrem Browserfenster, wird nicht gespeichert und ist nach dem Neuladen der Seite wieder weg. Beachten Sie: Die Anfragen gehen an die produktive API, schreibende Aufrufe (etwa POST oder DELETE) verändern also echte Daten.