RSJ LPS NG stellt folgende Web Services zur Verfügung
Parameter | Wert |
---|---|
URL | /submit |
Methode | POST |
Content-Type | multipart/form-data |
title | Job Bescreibung (zur Anzeige) |
format | Layout Id |
data | Daten (in CSV, JSON, XML or Excel) |
callback | Optionale JSONP Callback Funktion |
oauth_token | OAuth2 Access Token (wenn dieser im HTTP Authorization Header im Oauth Schema angegeben wurde) |
RSJ LPS NG unterstützt das OAuth2 Standard Protokoll zur sicheren Verbindung von unterschiedlichen Anwendungen für eine Vielzahl von Benutzern.
RSJ LPS NG nutzt die Authentisierung auch zur Steuerung der Druckausgabe.
Entwickler können externe Anwendungen für die Verbindung mit RSJ LPS NG online registrieren. Sie benötigen dazu:
Sie erhalten dabei:
Benutzer können externe Anwendungen mit RSJ LPS NG verknüpfen und diesen erlauben, RSJ LPS NG in ihrem Namen zu nutzen.
Die externen Anwendung übergibt folgende Parameter beim Redirect:
Parameter | Wert |
---|---|
URL | /authorize |
Methode | GET |
client_id | Client Id (aus Anwendung Registrierung) |
response_type | code |
scope | full |
redir_uri | Redirect URI (muss der bei der Anwendungsregistrierung angegebenen URI übereinstimmen) |
state | Optionale Kontext Informationen für Redirect |
Nach der erfolgreichen Autorisierung wird der Benutzer wieder zur externen Anwendung zurückgeleitet. Dabei werden folgende Parameter mitgegeben:
Die externe Anwendung kann über einen Web Service den temporären Autorisierungscode in einen permanten Refresh Token verwandeln. Sie übergibt dabei folgende Parameter:
Die externe Anwendung speichert den Refresh Token dauerhaft für den entsprechenden Benutzer.
Parameter | Wert |
---|---|
URL | /auth |
Methode | POST |
grant_type | refresh_token |
refresh_token | Refresh Token (aus der Anwendungs Autorisierung) |
Antwort | JSON Struktur |
Die externe Anwendung muss den Refresh Token in einen temporär (60 Minuten) gültigen Access Token umwandeln lassen um diesen in Web Service Requests zu verwenden. Sie ruft dazu einen Web Service Request mit folgenden Parametern auf:
Sie erhält:
Die externe Anwendung übergibt den Access Token in den Web Service Requests im Auth HTTP Header oder als Parameter
RSJ LPS NG schließt aus dem Access Token auf die externe Anwendung und den Benutzer.
Der Access Token kann jederzeit ungültig werden (selbst wenn er noch nicht abgelaufen ist). In diesem Fall wird der Fehler 401 zurückgegeben und die externe Anwendung muss einen neuen Access Token anfordern und dann mit diesem die Anforderung wiederholen.
Parameter | Wert |
---|---|
URL | /auth |
Methode | POST |
grant_type | authorization_code |
code | Authorization Code (aus Redirect) |
client_id | Client Id (aus Anwendung Registrierung) |
client_secret | Client Secret (aus Anwendungsregistrierung) |
refresh_token | Refresh Token (aus der Anwendungs Autorisierung) |
Antwort | JSON Struktur |