Verwendung eines SOAP-Web-Service zur Authentifizierung bei einer Anwendung

SOAP-Web-Service-Eingabeeinheiten- und Benachrichtigungsobjekte können für die Authentifizierung bei einer Anwendung einen SOAP-Web-Service verwenden. RICOH ProcessDirector unterstützt sowohl die API-Schlüssel- als auch die Sitzungsauthentifizierung. Eingabeeinheitenobjekte authentifizieren sich, wenn Sie eine Eingabe abfragen. Benachrichtigungsobjekte authentifizieren sich, wenn Sie einen Status an die Anwendung senden.

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 einem SOAP-Web-Service auf, 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. Das Token wird im Aufruf an den Web-Service übertragen, 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.

So verwenden Sie einen SOAP-Web-Service zur Authentifizierung:
  1. Klicken Sie auf die Registerkarte Authentifizierung auf der SOAP-Web-Service-Eingabeeinheit oder -Benachrichtigung.
  2. 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.
  3. Legen Sie das Mermal Authentifizierunganforderung URL- zu der URL fest, die RICOH ProcessDirector zur Authentifizierung bei der Anwendung verwendet.
    Wenn die Anwendung in der URL Anmeldeinformationen für die Authentifizierung erfordert, geben Sie diese mit dem erforderlichen Format und der Syntax ein.
  4. Geben Sie für den Wert des Merkmals Authentifizierungsanforderung Nutzdaten den Text der Web-Service-Anforderung ein, den die Eingabeeinheit oder Benachrichtigung zur Authentifizierung an die Anwendung sendet.
    In diesen Beispielen enthalten die Nutzdaten drei 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.

  5. Legen Sie das Merkmal Authentifizierung der SOAP-Anforderung auf die SOAP-Anforderung fest, die von RICOH ProcessDirector erstellt wurde, als Sie die WSDL-Datei importiert haben.
    Beispiel: Sie möchten die SOAP-Anforderung AuthenticateUser verwenden. Sie haben den Namen der SOAP-Anforderungen PrintShop vorangestellt, als Sie diese importiert haben. Wählen Sie PrintShop-AuthenticateUser.
  6. 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.
  7. 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.
Sowohl für die Authentifizierung per API-Schlüssel und die Sitzungsauthentifizierung speichert RICOH ProcessDirector die statische Anmeldeinformation oder das von der Anwendung in einem Merkmal zurückgegebenen Token.
  • Für Eingabeeinheiten lautet das Merkmal WebService.Credential.
  • Für Benachrichtigungen lautet das Merkmal WSNotification.WebService.Credential.

Wenn Sie die Werte auf der Registerkarte Anforderung für eine SOAP-Eingabeeinheit oder -Benachrichtigung festlegen, geben Sie das Merkmal WebService.Credential oder WSNotification.WebService.Credential als Symbol an.

RICOH ProcessDirector ersetzt das Symbol mit den Wert der statische Anmeldeinformation oder des Token, wenn es die Anforderung an den Web-Service überträgt.

Da Sie nun die Werte festgelegt haben, die zur Authentifizierung bei der Anwendung erforderlich sind, schließen Sie die Schritte für die Definition und Konfiguration der Eingabeeinheit oder Benachrichtigung ab. Kehren Sie zu einem der folgenden Themen zurück:
  • Vorbereitung zum Abrufen von SOAP-Web-Service-Eingaben.
  • Vorbereitung zum Senden des Status an einen SOAP-Web-Service.