Zum Inhalt springen

Authentifizierung

Alle API-Aufrufe authentifizieren sich mit einem Organisations-API-Schlüssel als Bearer-Token:

Authorization: Bearer <dein-api-schlüssel>

Der Schlüssel bindet jede Anfrage an genau eine Organisation. Es sind ausschließlich die Daten dieser Organisation sichtbar – Dokumenttypen, Partner und Läufe anderer Organisationen bleiben unerreichbar.

Die API-Schlüssel-Verwaltung erreicht ihr im Portal so:

  1. Oben links in der Ecke auf den Organisationsnamen klicken.
  2. „Organisationen verwalten“ wählen.
  3. Den Reiter „API Keys“ öffnen.

Dort legt ihr einen neuen Schlüssel an und kopiert ihn. Ein Schlüssel gehört immer zu der Organisation, in der ihr ihn erstellt; behandelt ihn wie ein Passwort und gebt ihn nicht an Dritte weiter.

Terminal-Fenster
curl https://api.legentio.com/v1/scans \
-H "Authorization: Bearer $SCAN_PORTAL_API_KEY"
Status Bedeutung
401 API-Schlüssel fehlt oder ist ungültig.
403 Der API-Schlüssel gehört zu keiner Organisation.

Fehlerantworten haben stets den Body { "error": "…" } mit einer deutschen Meldung.