Verwendung von RICOH ProcessDirector-REST-API-Dokumentation

RICOH ProcessDirector bietet REST-APIs für die Web-Service-Integration. Die interaktive Dokumentation, die mit diesen APIs bereitgestellt wird, bietet Live-Tests und Informationen für jede verfügbare API.

Die REST-API-Dokumentation umfasst viele APIs, die eine Anwendung für die Integration in RICOH ProcessDirector verwenden kann. Sie können die REST-API-Dokumentations- und Testschnittstelle zum Testen Ihre Parametereinstellungen verwenden. Wenn Sie die Schnittstelle zum Testen von Web-Services nutzen, greifen Sie auf den primären RICOH ProcessDirector-Server zu. Aktionen wie beispielsweise das Erstellen, Löschen und Aktivieren von Objekten werden auf dem primären Server ausgeführt und in der RICOH ProcessDirector-Benutzerschnittstelle angezeigt. Daher empfehlen wir das Erstellen von Objekten speziell zu Testzwecken.

Diese Schritte erläutern, wie Sie die Protokolldateien für ein Objekt mithilfe von REST-APIs anfordern. Diese Schritte melden Sie bei RICOH ProcessDirector an, fordern die Protokolldateien für den Musterdrucker an und melden Sie ab.

  1. Öffnen Sie einen Webbrowser, und geben Sie Ihren RICOH ProcessDirector-Hostnamen oder die IP-Adresse in die Adressleiste ein. Fügen Sie /restapi/ am Ende Ihres Hostnamens oder Ihrer IP-Adresse hinzu, um auf die REST-API-Dokumentation zuzugreifen. Zum Beispiel: http://Hostname:15080/restapi/
  2. Suchen Sie im Abschnitt Benutzer POST /users/login.
  3. Klicken Sie auf Probieren Sie es aus.
  4. Melden Sie sich bei RICOH ProcessDirector an, indem Sie Ihre RICOH ProcessDirector-Anmeldedaten eingeben:
    • Geben Sie für den Parameter Name Ihren RICOH ProcessDirector-Benutzernamen ein.
    • Geben Sie für den Parameter Kennwort das zu Ihrem RICOH ProcessDirector-Benutzernamen gehörige Kennwort ein.
  5. Klicken Sie auf Ausführen.
    Die REST-API-Dokumentation verwendet die Werte, die Sie eingeben, um einen cURL-Befehl und eine Anforderungs-URL zu erstellen. Dann übergibt sie die Anforderung an die Anforderungs-URL und meldet Sie an.

    RICOH ProcessDirector sendet eine Antwort, die angibt, ob Sie erfolgreich angemeldet wurden. Die Antwort enthält zusätzliche Informationen, einschließlich des Tokens und der Aktionen, zu denen diese Benutzer-ID berechtigt ist.

  6. Suchen Sie den Token-Wert im Feld Antwortteil, und kopieren Sie ihn.

  7. Scrollen Sie im Abschnitt objects nach unten bis zu POST /objects/log/{objectType}/{name}.
  8. Klicken Sie auf Probieren Sie es aus.
  9. Rufen Sie die Protokollnachrichten für den Musterdrucker ab, indem Sie diese Parameter eingeben:
    1. Fügen Sie für den Parameter Token das Token ein, das Sie oben kopiert haben.
    2. Geben Sie für den Parameter objectTypePrinter ein.
      Bei den Werten für "objectType" muss die Groß-/Kleinschreibung beachtet werden. Sie können den Webdienst POST /util/objecttypes verwenden, um eine Liste der auf Ihrem System verfügbaren Objekttypen zu erhalten. Den Webdienst POST /util/objecttypes finden Sie im Abschnitt util.
    3. Geben Sie für den Parameter NameSample ein.
  10. Klicken Sie auf Ausführen.
    Die Protokolleinträge für den Musterdrucker werden im Antwortteil-Feld zurückgegeben.

    Die cURL- und Anforderungs-URL-Werte werden ebenfalls zurückgegeben.

  11. Suchen Sie im Abschnitt Benutzer POST /users/logout/{name}.
  12. Klicken Sie auf Probieren Sie es aus.
  13. Melden Sie sich bei RICOH ProcessDirector ab:
    • Fügen Sie für den Parameter Token das Token ein, das Sie oben kopiert haben.
    • Geben Sie für den Parameter Name Ihren RICOH ProcessDirector-Benutzernamen ein.
  14. Klicken Sie auf Ausführen.
    Sie sind aus RICOH ProcessDirector abgemeldet.

  15. Beispielwerte sind im Lieferumfang bestimmter APIs enthalten. Mit Beispielwerten können Sie den Beispielcode aktualisieren und zu Testzwecken ändern.

    Diese Schritte demonstrieren, wie man mit einer REST-API einen Ordner für Sofortdruck mit einem Beispielwert verbindet. Diese Schritte melden Sie bei RICOH ProcessDirector an, richten die Eingabeeinheit, ein, um Dateien von HotFolderPDF anzunehmen, und melden Sie ab.

  16. Öffnen Sie die REST-API-Schnittstelle wie oben beschrieben.
  17. Suchen Sie im Abschnitt Benutzer POST /users/login.
  18. Klicken Sie auf Probieren Sie es aus.
  19. Melden Sie sich bei RICOH ProcessDirector an, indem Sie Ihre RICOH ProcessDirector-Anmeldedaten eingeben:
    • Geben Sie für den Parameter user Ihren Benutzernamen ein.
    • Geben Sie für den Parameter pwd das zu Ihrem Benutzernamen gehörige Kennwort ein.
  20. Klicken Sie auf Ausführen.
  21. Suchen Sie den Token-Wert im Feld Antwortteil, und kopieren Sie ihn.
  22. Scrollen Sie im Abschnitt objects bis zu POST /objects/{objectType}/connect.
  23. Klicken Sie auf Probieren Sie es aus.
  24. Verbinden Sie HotFolderPDF durch die Eingabe dieser Parameter:
    1. Fügen Sie für den Parameter Token das Token ein, das Sie oben kopiert haben.
    2. Geben Sie für den Parameter objectTypeInputDevice ein.
      Bei den Werten für "objectType" muss die Groß-/Kleinschreibung beachtet werden. Sie können den Webdienst POST /util/objecttypes verwenden, um eine Liste der auf Ihrem System verfügbaren Objekttypen zu erhalten. Den Webdienst POST /util/objecttypes finden Sie im Abschnitt util.
    3. Für den Nachrichtentext-Parameter klicken Sie auf Wert bearbeiten. Der Beispieltext wird in einem Codefeld angezeigt. Ersetzen Sie das Wort “string” durch “HotFolderPDF”. Stellen Sie sicher, dass der Name des Objekts in doppelten Anführungszeichen steht.
  25. Klicken Sie auf Ausführen.
    Die Merkmale und Einstellungen für HotFolderPDF werden im Antwortteil-Feld zurückgegeben. Der Antwortcode und die Antwortkopfzeilen werden auch zurückgegeben.
  26. Suchen Sie im Abschnitt Benutzer POST /users/logout/{name}.
  27. Klicken Sie auf Probieren Sie es aus.
  28. Melden Sie sich bei RICOH ProcessDirector ab:
    • Fügen Sie für den Parameter Token das Token ein, das Sie oben kopiert haben.
    • Geben Sie für den Parameter Name Ihren RICOH ProcessDirector-Benutzernamen ein.
  29. Klicken Sie auf Ausführen.
    Sie sind aus RICOH ProcessDirector abgemeldet.

Related information:

Übergabe von Jobs mithilfe von Web-Services vorbereiten
Übergeordnetes Thema: Web-Services in RICOH ProcessDirector