Authentifizierung

Damit Sie auf einen Application API-Endpunkt zugreifen zu können, müssen Sie (bzw. der API-Client) sich am API-Endpunkt authentifizieren.

Sie haben zwei Möglichkeiten, sich an einem Application API-Endpunkt zu authentifizieren.

Authentifizierung über API-Login-Endpunkt und Cookies (ohne API-Key)

Bei der ersten Möglichkeit, sich an einem Endpunkt zu authentifizieren, müssen Sie zunächst eine Anmeldung am Portal durchführen. Hierfür gibt es standardmäßig API-Endpunkte in Intrexx. Nach erfolgreicher Anmeldung am Portal gibt Intrexx ein Session-Cookie und ein CSRF-Token zurück. Mit diesen können dann Zugriffe auf Application API-Endpunkte authentifiziert werden. Diese Art der Authentifizierung dient hauptsächlich für Zugriffe aus Webseiten im Browser.

Eine detaillierte Übersicht und Beschreibung der Login-Endpunkte finden Sie in Abschnitt Login-API-Endpunkte.

Authentifizierung über API Keys

Die zweite Möglichkeit, sich an einem Endpunkt zu authentifizieren, erfolgt über API-Keys. Mit Hilfe von API Keys kann eine Authentifizierung am Portal erfolgen, ohne eine explizite Anmeldung über einen API-Login-Endpunkt und Cookies durchzuführen.

Damit die Authentifizierung über den API-Key durchgeführt werden kann, muss dieser in HTTP Requests als X-API-KEY Header mitgesendet werden.

Postman

API-Keys

Detaillierte Erläuterungen zu API-Keys finden Sie in Abschnitt API-Keys erstellen und verwalten.