Using RICOH ProcessDirector REST API documentation

RICOH ProcessDirector provides REST APIs for web service integration. Interactive documentation is provided with these APIs and provides live testing and information for each available API.

The REST API documentation includes many APIs that an application can use to integrate with RICOH ProcessDirector. You can use the REST API documentation and testing interface to test your parameter settings. When you use the interface to test web services, you access the RICOH ProcessDirector primary server. Actions such as creating, deleting, and enabling objects are executed on the primary server and are reflected in the RICOH ProcessDirector user interface. As a result, we suggest creating objects specifically for testing purposes.

These steps demonstrate how to request the log files for an object using REST APIs. These steps log you in to RICOH ProcessDirector, request the log files for the Sample printer, and log you out.

  1. Open a web browser and enter your RICOH ProcessDirector host name or IP address into the address bar. Add /restapi/ to the end of your host name or IP address to access the REST API documentation. For example, http://hostname:15080/restapi/
  2. In the users section and find POST /users/login.
  3. Click Try it out.
  4. Log in to RICOH ProcessDirector by entering your RICOH ProcessDirector credentials:
    • For the name parameter, enter your RICOH ProcessDirector user name.
    • For the pwd parameter, enter the password associated with your RICOH ProcessDirector user name.
  5. Click Execute.
    The REST API documentation uses the values you enter to build a Curl command and a Request URL. Then it submits the request to the request URL and logs you in.

    RICOH ProcessDirector sends a response indicating whether you successfully logged in. The response includes additional information including the token and the actions that this User ID is allowed to do.

  6. In the Response Body box, find and copy the token value.

  7. In the objects section, scroll down until you find POST /objects/log/{objectType}/{name}.
  8. Click Try it out.
  9. Retrieve the log messages for the Sample printer by entering these parameters:
    1. For the token parameter, paste the token you copied above.
    2. For the objectType parameter, type Printer.
      The values for objectType are case-sensitive. You can use the web service POST /util/objecttypes to get a list of object types available on your system. The web service POST /util/objecttypes is found in the util section.
    3. For the name parameter, type Sample.
  10. Click Execute.
    The log entries for the Sample printer are returned in the Response Body box.

    The Curl and Request URL values are also returned.

  11. In the users section find POST /users/logout/{name}.
  12. Click Try it out.
  13. Log out of RICOH ProcessDirector:
    • For the token parameter, paste the token you copied above.
    • For the name parameter, enter your RICOH ProcessDirector user name.
  14. Click Execute.
    You are logged out of RICOH ProcessDirector.

  15. Example values are included with certain APIs. With example values you can update the sample code and modify it for testing.

    These steps demonstrate how to use a REST API to connect a hot folder using an example value. These steps log you in to RICOH ProcessDirector, set the Input Device to accept files from HotFolderPDF, and log you out.

  16. Open the REST API interface as above.
  17. In the users section and find POST /users/login.
  18. Click Try it out.
  19. Log in to RICOH ProcessDirector by entering your RICOH ProcessDirector credentials:
    • For the name parameter, enter your user name.
    • For the pwd parameter, enter the password associated with your user name.
  20. Click Execute.
  21. In the Response Body box, find and copy the token value.
  22. In the objects section, scroll until you find POST /objects/{objectType}/connect.
  23. Click Try it out.
  24. Connect HotFolderPDF by entering these parameters:
    1. For the token parameter, paste the token you copied above.
    2. For the objectType parameter, type InputDevice.
      The values for objectType are case-sensitive. You can use the web service POST /util/objecttypes to get a list of object types available on your system. The web service POST /util/objecttypes is found in the util section.
    3. For the body parameter, click Edit Value. Example text displays in a code box. Replace the word “string” with “HotFolderPDF”. Make sure the double quotes are around the name of the object.
  25. Click Execute.
    The properties and settings for HotFolderPDF are returned in the Response Body box. The Response Code and Response Headers are also returned.
  26. In the users section find POST /users/logout/{name}.
  27. Click Try it out.
  28. Log out of RICOH ProcessDirector:
    • For the token parameter, paste the token you copied above.
    • For the name parameter, enter your RICOH ProcessDirector user name.
  29. Click Execute.
    You are logged out of RICOH ProcessDirector.

Related information:

Preparing to submit jobs using web services
Parent topic: Web services in RICOH ProcessDirector