Verwendung eines REST-Web-Service zur Authentifizierung bei einer Anwendung
Für eine Authentifizierung per API-Schlüssel setzen Sie einen Autorisierungscode in ein Merkmal Statische Anmeldeinformation oder definieren eine HTTP-Benutzer-ID und ein Kennwort. Die Eingabeeinheit oder Benachrichtigung leitet den Autorisierungscode oder die HTTP-Benutzer-ID und das Kennwort für den Web-Service weiter, der den Datenaustausch durchführt. Der Web-Service authentifiziert sich dann bei der Anwendung und gibt eine Antwort zurück.
Für eine Sitzungsauthentifizierung setzen Sie Anmeldeinformationen für die Authentifizierung (Benutzer-ID und Kennwort) und andere Werte in einen Satz von Authentifizierungsanforderungsmerkmalen. Die Eingabeeinheit oder Benachrichtigung ruft zunächst einen REST-Web-Service ab, um sich bei der Anwendung zu authentifizieren. Nach einer erfolgreichen Authentifizierung gibt der Web-Service ein Token für die Eingabeeinheit oder Benachrichtigung zurück. Die Eingabeeinheit oder Benachrichtigung sendet dann das Token im Aufruf an den Web-Service, der den Datenaustausch durchführt.
- Wenn die Anwendung eine Sitzung pro Benutzer zulässt, richten Sie Ihre Eingabeeinheiten und Benachrichtigungen so ein, dass die Web-Services mit unterschiedlichen Benutzer-IDs und Kennwörtern aufgerufen werden.
- Eine Sitzungsauthentifizierung erfolgt mit jedem Aufruf eines Web-Service, und ein Abmelden ist nicht erforderlich. Stellen Sie sicher, dass die Länge der Sitzung für jeden Satz von Anmeldeinformationen kürzer ist als die Zeit zwischen den Aufrufen beim Web-Service. Beispiel: Die Sitzung für eine Eingabeeinheit läuft nach 10 Minuten ab. Legen Sie bei der Konfiguration der Eingabeeinheit ein Abrufintervall von mehr als 10 Minuten fest.
Um einen API-Schlüssel oder Anmeldeinformationen für die Authentifizierung bei einer Anwendung zu erhalten, wenden Sie sich an das Unternehmen, das die Anwendung hostet. Informationen über das Format und die Syntax finden Sie in der Dokumentation der Anwendung.
- Klicken Sie auf die Registerkarte Authentifizierung auf dem REST-Web-Service für die Eingabeeinheit oder Benachrichtigung.
- Befolgen Sie die Anweisungen für den Typ der Authentifizierung, den die Anwendung
verlangt:
- Für eine Authentifizierung per API-Schlüssel legen Sie den Authentifizierungscode
als Wert für das Merkmal Statische Anmeldeinformation fest.
Lassen Sie alle anderen Merkmale leer. Sie haben dieses Verfahren abgeschlossen.
- Für eine Sitzungsauthentifizierung lassen Sie das Merkmal Statische Anmeldeinformation leer. Gehen Sie zum nächsten Schritt und legen Sie die anderen Merkmale fest.
- Für eine Authentifizierung per API-Schlüssel legen Sie den Authentifizierungscode
als Wert für das Merkmal Statische Anmeldeinformation fest.
- Legen Sie das Mermal Authentifizierunganforderung URL- zu der URL fest, die RICOH ProcessDirector zur Authentifizierung bei der Anwendung verwendet.
- Legen Sie die Anmeldeinformationen für die Authentifizierung durch Eingabe von Werten
fest, die von der Anwendung in einem oder mehreren der folgenden Merkmale verlangt
werden: Authentifizierungsanforderung Nutzdaten, Authentifizierungsanforderung Header und Authentifizierungsanforderung Parameter.
- Für den Wert des Merkmals Anforderungsnutzdaten legen Sie den Text (falls vorhanden) der Authentifizierungsanforderung fest, den
die Eingabeeinheit oder Benachrichtigung an die Anwendung sendet.
In diesen Beispielen enthalten die Nutzdaten drei XML-Elemente: <Anmeldeinformationen>, <Name> und <Kennwort>. Der Wert des Elements <Kennwort> ist ein Symbol, welches das Merkmal Authentifizierungsanforderung Kennwort verwendet.
Dieses Beispiel verwendet das Merkmal Authentifizierungsanforderung Kennwort für Eingabeeinheiten:
<Anmeldeinformationen> <Name>myname</Name> <Kennwort>${WebService.AuthRequestPwd}</Kennwort> </Anmeldeinformationen>
Dieses Beispiel verwendet das Merkmal Authentifizierungsanforderung Kennwort für Benachrichtigungen:
<Anmeldeinformationen> <Name>Meinname</Name> <Kennwort>${WSNotification.WebService.AuthRequestPwd}</Kennwort> </Anmeldeinformationen>
Die Eingabeeinheit oder Benachrichtigung löst das Symbol auf, wenn die Authentifizierungsanforderung gesendet wird.
- Legen Sie die Werte für die Merkmale Anforderungsheader und Parameter anfordern nach Bedarf fest.
Jedes Header-Feld bzw. jeder Parameter ist ein Schlüsselwort-/Wertepaar. Jedes Paar muss auf einer separaten Zeile stehen und mit einem Doppelpunkt (:) oder Gleichheitszeichen (=) getrennt sein.
Das Schlüsselwort und der Wert können mehrere Wörter sein. RICOH ProcessDirector verwendet das erste Semikolon oder Gleichheitszeichen auf jeder Zeile, um die Wörter in das Schlüsselwort-/Wertepaar aufzuteilen.
Diese Beispiele enthalten zwei Parameter: name und pwd. Der Wert des Schlüsselworts pwd ist ein Symbol, welches das Merkmal Authentifizierungsanforderung Kennwort verwendet.
Dieses Beispiel verwendet das Merkmal Authentifizierungsanforderung Kennwort für Eingabeeinheiten:
name:myname pwd:${WebService.AuthRequestPwd}
Dieses Beispiel verwendet das Merkmal Authentifizierungsanforderung Kennwort für Benachrichtigungen:
name:myname pwd:${WSNotification.WebService.AuthRequestPwd}
Die Eingabeeinheit oder Benachrichtigung löst das Symbol auf, wenn die Authentifizierungsanforderung gesendet wird.
- Für den Wert des Merkmals Anforderungsnutzdaten legen Sie den Text (falls vorhanden) der Authentifizierungsanforderung fest, den
die Eingabeeinheit oder Benachrichtigung an die Anwendung sendet.
- Legen Sie die Merkmale Anforderungsmethode und Anforderungsinhaltstyp mit den Werten fest, die vom Web-Service verlangt werden.
- Legen Sie das Merkmal Authentifizierungsantwort Attribut auf den xPath-Ausdruck fest, der die Anmeldeinformation für die Sitzung in der Antwort vom Web-Service identifiziert.
- Legen Sie das Merkmal Authentifizierungsanforderung Kennwort auf das Passwort für Ihr Benutzerkonto bei der Anwendung fest.Das Kennwort wird verschlüsselt, wenn es in RICOH ProcessDirector gespeichert wird.
- Für Eingabeeinheiten lautet das Merkmal WebService.Credential.
- Für Benachrichtigungen lautet das Merkmal WSNotification.WebService.Credential.
Wenn Sie auf der Registerkarte Anforderung Werte für eine Web-Service-Eingabeeinheit oder -Benachrichtigung festlegen, legen Sie das Merkmal WebService.Credential oder WSNotification.WebService.Credential als Symbol fest.
RICOH ProcessDirector ersetzt den Wert der statische Anmeldeinformation oder des Tokens für das Symbol, wenn es die Anforderung an einen Web-Service überträgt.
- Vorbereitung zum Abrufen von REST-Web-Service-Eingaben.
- Vorbereitung zum Senden des Status an einen REST-Web-Service.