Zweck: Über die REST-API von FORCAM FORCE greifen externe Programme (z.B. das Next.js-Dashboard) auf Maschinendaten, KPIs, Auftragsdaten und Konfigurationen zu. Diese Seite beschreibt die Schnittstelle und wie man ein Zugangs-Token bekommt.

Swagger UI – das interaktive Handbuch Erreichbar auf VM 104. Listet alle Endpunkte übersichtlich auf und ist interaktiv: Aufrufe lassen sich direkt im Browser ausführen und die echte Server-Antwort ansehen, ohne Code zu schreiben.

ParameterWert

URL-Schema

https://<anwendungsserver>:25443/swagger-ui

Format

OpenAPI 3.0 / JSON

Interaktiv

Direktes Testen aller Endpunkte im Browser

Auth

Bearer Token direkt im Swagger-Interface konfigurierbar

REST-API – Technische Spezifikation

ParameterWert

Protokoll

REST (Representational State Transfer)

Datenformat

JSON (application/json)

Transport

HTTPS (TLS, Port 25443)

Auth

Bearer Token (JWT), über Keycloak bezogen

Token-Beschaffung (OAuth2 Client Credentials Flow) Für automatisierte Zugriffe (Machine-to-Machine). Ein technischer Service Account erzeugt ein signiertes JWT.

Anfrage:

POST /ffauth/realms/FORCAM/protocol/openid-connect/token Content-Type: application/x-www-form-urlencoded grant_type=client_credentials&client_id=<id>&client_secret=<secret>

Antwort (Access Token meist 5 Minuten gültig):

{  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIg...",  "expires_in": 300,  "refresh_expires_in": 1800,  "token_type": "Bearer",  "not-before-policy": 0 }

Jeder Datenabruf sendet das Token im Authorization-Header:

GET /api/v1/workplace/status Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIg... Accept: application/json

⚠ Wichtig fürs Dashboard: Wegen der 5-Minuten-Gültigkeit muss ein automatischer Token-Refresh implementiert werden, sonst reißt die Verbindung ab.

⚠ Aktuell blockiert: Token-Abruf scheitert derzeit an fehlenden Admin-Credentials und dem SAN-Mismatch → siehe Bekannte Zugangsprobleme. Workaround → Middleware-Konzept.

Verwandte Seiten: Keycloak / SSO · Bekannte Zugangsprobleme · Middleware-Konzept · Next.js Dashboard