Integration externer Anwendungen
Web Services
RSJ LPSNG stellt folgende Web Services zur Verfügung:
- Erzeugung eines Label Inhalts
- Direkter Druck eines Labels (On Premises Version)
- Übergabe von Druck Jobs
Erzeugung eines Label Inhalts
| Parameter || Wert || || URL || /produceLabel || || Methode || GET oder POST || || Content-Type || multipart/form-data || || id || Layout Id || || _targetFormat || pdf oder png || || _width || Nur für PNG: Breite in Pixel. Default: 1000 || || _height || Nur für PNG: Höhe in Pixel. Default: 1000 || || Parameter für das Layout || Wert ||
Dieser Web Service liefert das Label (in PDF oder PNG Format) direkt in der Response.
Direkter Druck eines Labels auf angeschlossenem Drucker
| Parameter || Wert || || URL || /printLabel || || Methode || GET oder POST || || Content-Type || multipart/form-data || || id || Layout Id || || _targetDevice | Drucker Name (aus Konfigurationsdatei) || || _action || print oder raw Default: print || || Parameter für das Layout || Wert || Druckt das erzeugte Labels sofort auf dem direkt am Server angeschlossenen Drucker aus. Mit der _action raw kann statt des Drucks der Druckdatenstrom im Client Browser als Datei gespeichert werden.
Diese Funktion ist nur in der On Premises Version verfügbar.
Übergabe von Druck Jobs
| Parameter | Wert |
| URL | /submit |
| Methode | POST |
| Content-Type | multipart/form-data |
| title | Job Beschreibung (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) |
Dieser Web Service stellt einen neuen Label Auftrag (mit einem oder mehreren Labels) in die Queue. Das Ergebnis ist dort nach einigen Sekunden abrufbar (und wird entsprechend der Konfiguration ggf weitergeleitet).
Anwendungsverknüpfung
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.
Registrierung externer Anwendungen
Entwickler können externe Anwendungen für die Verbindung mit RSJ LPSNG online registrieren. Sie benötigen dazu:
- Anwendungs Name
- Anwendungs Beschreibung
- Anwendungs Ikone
- Anwendungs Redirect URL (nach Anwendungsverknüpfung)
Sie erhalten dabei:
- Application Id
- Application Secret
Autorisierung externer Anwendungen
Benutzer können externe Anwendungen mit RSJ LPS NG verknüpfen und diesen erlauben, RSJ LPSNG in ihrem Namen zu nutzen.
Benutzer Sicht
1) Der Benutzer clickt auf einen Link in der externen Anwendung, welche ihn zur RSJ LPS NG Anmeldung (soweit er noch nicht angemeldet ist) und dann zur RSJ LPSNG Anwendungsverknüpfung bringt.
2) Wenn der Benutzer Anwendungsverbindung genehmigt, wird er an die externe Anwendung zurückgeleitet, um die Authentifizierungsinformationen zu speichern.
Sicht der externen Anwendung
Die externen Anwendung übergibt folgende Parameter beim Redirect:
- Application Id (aus Anwendungs Registrierung)
- Callback URL (muss mit der bei der Anwendungsregistrierung angebenen URL übereinstimmen)
- Optionale Context Informationen (für 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:
- Kontext Information (aus redirect)
- Temporärer (10 Minuten gültiger) Autorisierungscode
Die externe Anwendung kann über einen Web Service den temporären Autorisierungscode in einen permanten Refresh Token verwandeln.
Sie übergibt dabei folgende Parameter:
- Temporärer Autorisierungscode
- Application Id
- Application Secret
- Callback URL
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 |
Request von externe Anwendungen
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:
- Refresh Token
Sie erhält:
- Temporärer (60 Minuten gültiger) Access Token
Die externe Anwendung übergibt den Access Token in den Web Service Requests im Auth HTTP Header oder als Parameter
RSJ LPSNG 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 |
Einsatzmöglichkeiten
- Features
- ESL
- Deployment
- Präsentation
Kontakt
Gerne helfen wir mit weiteren Informationen:
Or contact us directly:
RSJ Software GmbH
Holzstrasse 4
82120 Germering
Germany
Phone: +49 89 89 41 42-0
Fax: +49 89 89 41 42-80
E-Mail: info@rsj.de
