OAuth2 für API Zugriffe

Ab Version 4.10.0 und Lobster_data 4.6 kann auf Lobster_pro über ein OAuth2 Bearer Token zugegriffen werden.

Dazu müssen über die Partner Verwaltung API Zugriffe gemäß der Lobster_data Anleitung eingerichtet werden.

Über die Zusatzkennung SYS_PRO_USER muss der Kanal mit einem Lobster_pro Benutzeraccount verknüpft werden.

Es wird empfohlen einen Benutzer mit nur einer Rolle und einer Firma zu verwenden. Andernfalls wird einfach jeweils die erste Rolle / Firma verwendet.
Optional kann dies noch über die Header X-ENV-Preferred-Role und X-ENV-Preferred-Company gesteuert werden.

Die Authentifizierung erfolgt über das von Lobster_data vergebenen Bearer Token und muss über den Header Authorization: Bearer {token} übergeben werden.

Sind SSO Provider im System registriert, können auch gültige Bearer Token der entsprechenden Herausgeber verwendet werden. Hierbei greift die normale Verknüpfung des Benutzers mit dem SSO Account.


Anlage des Partnerkanals Http(s):

images/download/attachments/157877146/image-2023-6-21_8-29-12-version-1-modificationdate-1699615487386-api-v2.png

Hier sind im Bereich "Partner-Zugang (Partner zu mir)" die Notwendigen Information für die OAuth2 Autorisierung zu finden:

images/download/attachments/157877146/image-2023-6-21_8-30-44-version-1-modificationdate-1699615487384-api-v2.png

Wichtig: Der verwendete Benutzer sollte nur genau eine Rolle und eine Firma haben, denn ansonsten muss die bevorzugte Rolle und Firma über den Header gesetzt werden (X-ENV-Preferred-Role / X-ENV-Preferred-Role)


Der zu verwendende _pro Benutzer wird ermittelt aus der Zusatzkennung SYS_PRO_USER, falls diese nicht gesetzt ist, wird die Partner Kennung verwendet.

images/download/attachments/157877146/image-2023-6-21_8-33-3-version-1-modificationdate-1699615487378-api-v2.png


Um nun auf das System zugreifen zu können, muss der OAuth2 Authentifizierungsflow durchlaufen werden. Dies kann z.B. mit SoapUI getestet werden:

images/download/attachments/157877146/image-2023-6-21_8-41-34-version-1-modificationdate-1699615487375-api-v2.png

Über die Funktion "Get Access Token" wird nun das OAuth2 Bearer Token abgerufen:

images/download/attachments/157877146/image-2023-6-21_8-42-29-version-1-modificationdate-1699615487331-api-v2.png

Über dieses Token (mittels des Headers Authorization: Bearer {token}) kann nun als "my_api_user" auf das System zugegriffen werden um z.B. die eigene Sitzungsinformatonen abzurufen:

images/download/attachments/157877146/image-2023-6-21_9-29-26-version-1-modificationdate-1699615487324-api-v2.png