Lobster Platform API (Preview)

Die Lobster Platform API ist eine REST-API der Lobster Data Platform. Sie richtet sich an Headless-Szenarien und KI-Agenten, die Plattforminhalte ohne die Weboberfläche abfragen. In der aktuellen Version stellt die API lesenden Zugriff auf Profile, Integrationspartner und deren Kanäle bereit.

Preview-Status (v1): Die API befindet sich in der Entwicklungsphase und wird aktiv weiterentwickelt. Breaking Changes an Endpunkten und Schemas sind jederzeit möglich, auch wenn sie nach Möglichkeit vermieden werden. Abwärtskompatibilität ist erst mit der Freigabe einer stabilen Version garantiert.

Verfügbarkeit

Die API ist ab Version 26.3.0 verfügbar. Alle Endpunkte sind lesend (GET).

Die Basis-URL lautet:

https://<host>/platform/api/v1beta/

Eine interaktive API-Referenz mit allen Endpunkten und Schemas steht mit dem Stand vom 10. Juli 2026 hier im Dokumentationsportal zur Verfügung. Die OpenAPI-Spezifikation kann unter /platform/api/preview/openapi.json abgerufen werden.

Authentifizierung

Alle Anfragen benötigen ein Bearer-Token im HTTP-Header:

Authorization: Bearer <token>

Für den Bezug des Tokens stehen drei Wege zur Verfügung.

OAuth2 Client Credentials (Maschine zu Maschine)

Client-ID und Client-Secret werden in der Lobster-Administration angelegt. Das Token wird per Client-Credentials-Flow abgerufen:

POST /dw/register/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=<id>&client_secret=<secret>

Bearer-Token aus einer UI-Session

Nach der Anmeldung im Lobster Web-Client kann das Session-Cookie gegen ein Bearer-Token getauscht werden:

GET /auth/sessionBearerToken

GuestUser mit Login-Token

Ein GuestUser-loginToken als URL-Parameter baut eine Session ohne Passwort auf. Anschließend wird das Bearer-Token wie bei der UI-Session abgerufen:

GET https://<host>/?loginToken=<GuestUser-Token>
GET /auth/sessionBearerToken

Endpunkte

Methode und Pfad	Beschreibung
`GET /platform/api/preview/profiles`	Listet alle Profile auf, die der Aufrufer sehen darf.
`GET /platform/api/preview/profiles/{id}`	Liefert ein einzelnes Profil.
`GET /platform/api/preview/partners`	Listet alle Integrationspartner auf.
`GET /platform/api/preview/partners/{id}`	Liefert einen einzelnen Integrationspartner.
`GET /platform/api/preview/partners/{partnerId}/channels`	Listet alle Kanäle eines Integrationspartners auf.
`GET /platform/api/preview/partners/{partnerId}/channels/{id}`	Liefert einen einzelnen Kanal eines Integrationspartners.

Details zu den Antwortschemas, etwa den Feldern von Profilen und Kanaltypen (unter anderem AS2, SFTP, HTTP, OFTP, X.400), enthält die Swagger UI der jeweiligen Instanz.

Fehlerbehandlung

Fehlgeschlagene Anfragen liefern einen einheitlichen Fehler-Envelope. Das Objekt errorInfo enthält einen maschinenlesbaren errorCode, einen lesbaren errorText und den httpResponseStatus. Mögliche Statuscodes sind 400 (ungültige Anfrage), 401 (nicht authentifiziert), 403 (keine Berechtigung), 404 (nicht gefunden) und 500 (Serverfehler).

Versionierung und Breaking Changes

Während der Beta-Phase gelten folgende Regeln:

Änderung	Einstufung
Neue Felder, Enum-Werte oder Units kommen hinzu	Non-breaking: Clients müssen unbekannte Felder und Werte tolerieren.
Bestehende Felder, Units oder Enum-Werte werden entfernt oder ihr Typ geändert	Breaking: Während der Beta-Phase möglich, wird aber nach Möglichkeit vermieden.

Mit der Freigabe einer stabilen v1 entfällt die Möglichkeit von Breaking Changes ohne Versionswechsel.

Aktueller Funktionsumfang

Die erste Preview bildet Profile bisher nicht vollständig ab. Integration Units und Response Units sind derzeit nicht enthalten und werden mit der weiteren Reifung der API ergänzt.

Documentation Index