API Keys
Ein API Key entspricht einer statischen Session im BPC. Wie eine User-Session enthält dieser Attribute wie zugeordnete Organisationen, Rollen und Rechte. Jeder API Key enthält einen definierten Gültigkeitszeitraum. Zusätzlich kann angegeben werden, von wem und für wen dieser API Key ausgestellt wurde.
Verwendung des API Keys
API Keys kommen sowohl beim Aufruf von API-Endpunkten als auch bei der Konfiguration von Deployment Systemen zum Einsatz.
Aufruf eines API-Endpunktes
Für den Zugriff auf die BPC API gibt es neben dem normalen Userlogin auch die Möglichkeit, einen API Key zu verwenden. Damit ist eine direkte Authentifizierung beim API-Aufruf möglich. Ohne einen API Key muss vor dem Zugriff auf eine API-Funktion ein gesonderter Authentifizierungsaufruf getätigt werden.
Damit das BPC den API Key zur Authentifizierung annimmt, muss dieser im HTTP-Header X-APIKey mitgeschickt werden.
curl --header "X-APIKey: bed3a955ce73feb7186bd3f4a689a6f46b7b6264c30d0236dde87a26fc5acdbf" 'http://localhost:8181/cxf/bpc-core/status'Deployment System
Damit die Deployment-Funktion verwendet werden kann, müssen Deployment Systeme als Backend Connections vom Typ deployment_system angelegt werden (siehe Backend Connections).
Bei jedem dieser Deployment Systeme muss ein API Key hinterlegt werden.
Verwaltung von API Keys
API Keys werden im Modul API Keys verwaltet. Dort ist beschrieben, wie Sie API Keys anlegen, kopieren und löschen und welche Organisationen, Rollen und Rechte Sie einem API Key zuordnen können.
|
Ein API Key kann nach dem Speichern nicht mehr eingesehen werden. Kopieren Sie den Schlüssel deshalb direkt beim Anlegen des API Keys. |
