OAuth2 for API access
An OAuth2 bearer token can be used to access Lobster Data Platform / Integration.
To do this, access must be set up via the Partner Management API in accordance with the respective instructions for Lobster Data Platform / Integration.
The channel must be linked to a user account (see Users) via the additional identifier SYS_PRO_USER.
It is recommended to use a user with only one role and one company. Otherwise, simply use the first role/company in each case.
Optionally, this can also be controlled via the X-ENV-Preferred-Role and X-ENV-Preferred-Company headers.
Authentication takes place via the assigned bearer token assigned and must be transferred via the Authorization: Bearer {token} header.
If SSO providers are registered in the system, valid bearer tokens from the corresponding issuers can also be used. The normal linking of the user with the SSO account applies here.
Creation of the partner channel HTTP(s):
The information required for OAuth2 authorization can be found here in the 'Partner access (Partner to me)' area:
â–ºIMPORTANTâ—„ The user used should only have exactly one role and one company, otherwise the preferred role and company must be set via the header (X-ENV-Preferred-Role / X-ENV-Preferred-Role).
The _pro user to be used is determined from the additional identifier SYS_PRO_USER; if this is not set, the partner identifier is used.
To be able to access the system, the OAuth2 authentication flow must be run through. This can be tested with SoapUI, for example:
The OAuth2 bearer token is now retrieved via the 'Get Access Token' function:
This token (using theAuthorization: Bearer {token} header) can now be used to access the system as 'my_api_user', e.g. to retrieve your own session information:
