Web services in RICOH ProcessDirector

RICOH ProcessDirector provides web services that use Representational State Transfer (REST) software architecture principles so you can access its functions from other applications.

RESTful web services send requests and receive results using the Hypertext Transfer Protocol (HTTP). Each web service has a Universal Resource Indicator (URI) associated with it. When you create requests, you modify the URI to include specific information about the object that you are interested in or the action that you want to do. These modifications can be simple, such as inserting the name of a printer object into the URI, or highly complex, such as using Extensible Markup Language (XML) to describe the criteria to use when searching for objects and how they should be sorted when they are returned. If you code XML elements to include in your requests, they must be Universal Resource Locator (URL)-encoded before they are added to the URI.

With RICOH ProcessDirector, you can use web services to request information about print jobs and other objects in the system. You can also use them to set properties and do actions such as enabling and disabling objects, modifying properties, and starting and stopping printers.

In this section:

  1. 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.
  2. Usage notes
    The web services provided with RICOH ProcessDirector follow specific conventions. When you integrate web services with your application, refer to these usage notes to make sure that your implementation functions properly.
Parent topic: Product overview