REST-API & Token-Beschaffung
Zweck: Programmatischer Zugriff auf alle Maschinendaten, KPIs, Auftragsdaten und Konfigurationen des FORCAM Data Lake. Läuft auf VM 104.
Grundlagen: REST-Architektur, Datenformat JSON, Transport ausschließlich über HTTPS (TLS-verschlüsselt). Jeder Zugriff braucht ein gültiges Bearer-Token (JWT) von Keycloak.
Swagger UI – interaktive API-Dokumentation
Listet alle Endpunkte auf und erlaubt direktes Testen im Browser ohne eigenen Code. Bearer-Token lässt sich direkt im Interface hinterlegen.
Parameter
Wert
URL
https://<anwendungsserver>:25443/swagger-ui
Format
OpenAPI 3.0 / JSON
Authentifizierung
Bearer Token direkt im Interface konfigurierbar
Token holen (OAuth2 Client Credentials Flow)
Für automatisierte Zugriffe (Machine-to-Machine). Ein technischer Service-Account erzeugt über Client ID + Client Secret ein signiertes JWT.
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 bei Erfolg (Access Token typischerweise 5 Minuten gültig):
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIg...",
"expires_in": 300,
"refresh_expires_in": 1800,
"token_type": "Bearer",
"not-before-policy": 0
}
Token verwenden
Jeder Datenabruf muss das Token im Authorization-Header mitsenden:
GET /api/v1/workplace/status
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIg...
Accept: application/json
Wichtige Fallstricke
- Access Token nur ca. 5 Minuten gültig – bei Dauerbetrieb automatischen Token-Refresh implementieren
- Client Secret niemals im Frontend/Client-Code – nur serverseitig verwenden
- Token-Abruf über Port 25443 scheitert aktuell am SAN-Mismatch (siehe Bekannte Zugangsprobleme)
Verwandte Seiten: Keycloak / SSO · Bekannte Zugangsprobleme · Middleware-Konzept · Netzwerk-Routing