Trying out the Data Export API

Follow this procedure for a brief introduction to the API, using the interactive documentation page as a guide.

Before you start this task, create an API key using RICOH Account Administration.

This procedure walks you through:

  1. Authenticating the interactive documentation page
  2. Retrieving the list of printer IDs for the printers in your account
  3. Retrieving the status of one or more printers
  4. Requesting information about jobs associated with one or more of those printers

To use the Data Export API:

  1. Open the Data Export API interactive documentation here:
  2. Authenticate using an API key:
    1. Click Authorize on the right side of the page.
    2. In the Available Authorizations dialog, enter your API key in the Value field.
      Available authorizations dialog
    1. Click Authorize to authenticate.
    2. Click Close.
    You can now test the available API functions. Use this interface to familiarize yourself with the syntax before integrating the API into your applications.
  3. Retrieve the list of printer IDs for the printers defined in your account.
    To retrieve job and printer status information, you must include printer ID values in your API requests. Printer IDs do not change. If you retrieve them now and save the values, you can use the IDs in other API calls.
    1. Open the Printers section, then open the GET /printers endpoint.
      You see that no parameters are required for this endpoint.
    2. Click Try it out, then click Execute.
    3. Review the response body. You see a list of details about the printers that are monitored by RICOH Predictive Insight. The response looks similar to this:
      [
  {
    "printerName": "VC80_2",
    "printerId": "0bc6b7b3-8df9-4293-cdd4-5ae3162c4d4c",
    "engines": 2,
    "manufacturer": "Ricoh",
    "model": "RICOH Pro VC80000",
    "printerMode": "duplex",
    "printerType": "continuous_feed",
    "serialNumber": "Printer 1: 10-11111 and Printer 2: 10-11112",
    "connectionStatus": "not_connected"
  },
  {
    "printerName": "IP 5000",
    "printerId": "0f8726da-8q37-9c3l-8710-065d7c265122",
    "engines": 1,
    "manufacturer": "InfoPrint",
    "model": "InfoPrint 5000 GP v3.17.129",
    "printerMode": "simplex",
    "printerType": "continuous_feed",
    "serialNumber": "10-1111111",
    "connectionStatus": "connected"
  }
]

      Record the values of the printerId parameters for each of your printers.

  4. Request the printer state history for one or more printers in your system.
    1. Open the GET /printer-states endpoint.
    2. Click Try it out.
    3. Next to printerId, click Add string item.
    4. Replace the text in the field with one of the printer ID values that you retrieved in step .
      To retrieve status history for additional printers, click Add string item again and add another printer ID value.
    5. For timezone, choose the timezone to use for the data.
    6. Specify start and end times for the time range to report on. Leave these values blank to retrieve data for the previous 24 hours.
    7. Leave the last three values set to the default, so you can see the full list of information that the API can return.
    8. Click Execute.
    9. Review the response body. You see a list of printer state data for each printer engine, one stanza for each printer state change.
    10. Change the values for the currentState, stateCategoryOnly, and stateCategory parameters and click Execute again to see how the response changes.
      • Leaving these parameters set to the default (unset) has the same effect as setting them to false.
      • You can use these alone or in combination with each other.
  5. Request information about jobs associated with one or more of those printers:
    1. Open Jobs section of the page.
    2. Open the GET /jobs endpoint.
    3. Click Try it out.
    4. Next to printerId, click Add string item.
    5. Replace the text in the field with one of the printer ID values that you retrieved in step .
      To retrieve job information for additional printers, click Add string item again and add another printer ID value.
    6. For timezone, choose the timezone to use for the data.
    7. Specify start and end times for the time range to report on. Leave these values blank to retrieve data for the previous 24 hours.
    8. For jobState, leave the value blank to see the full range of responses that the API can return.
    9. Click Execute.
    10. Review the response to see the job information returned.
    11. Change the value for jobState and click Execute again to see how the response changes.
Parent topic: Working with the Data Export API – BETA