API Keys Tab

The API Keys tab is available only if your account has a subscription to RICOH Predictive Insight. To see the tab and work with keys, you must have Administrator access to Account Administration.

Two links at the top of the tab open reference information for the Data Export API:

Getting started with API keys

Opens the help for the Data Export API, where you can read about what you need to do to start using API keys, along with the available endpoints, the fields that each one returns, and the limits that apply to requests.

Open the API Explorer

Opens the interactive documentation page for the API, where you can review each endpoint, see the parameters it accepts, and submit sample requests directly from your browser. You need the value of an API key to submit a request from that page.

Here are the actions that you can do on this tab:

• View all the keys defined for your account and their properties, such as: Name, Status, and Expiration date.

  The table does not display the value of a key.

• Create a key.

  Click Create API Key. Keys are usually active within 30 seconds, but delays are possible.

• Monitor the account's API requests against subscription limits.

  The box above the API keys table shows the account's usage plan and the maximum API calls permitted for a 30 day period. Track how many calls have been made in the previous 30 days.

• Edit the name, description, or expiration date of an existing key.

  Right-click a row and select Edit API Key. Editing a key does not change its value, so applications that already use the key continue to work.

• Rotate a key to replace its value.

  Right-click a row and select Rotate API Key. Set an overlap period so that the existing value and the new value both work for a number of days, which gives you time to update your applications. The key with the new value is usually available for use within 30 seconds, but delays are possible.

• Delete a key.

  Right-click a row and select Delete immediately.

  Note:
  • Deleting a key removes it from the system within a minute, though delays are possible. Deleted keys are removed permanently. If you try to issue an API request using a key after deleting it, the request fails.
  • Deleting a key deletes all versions of the key. If you rotate a key then delete it, both versions of the key are deleted, even if the overlap period is still active.

Keys are not restricted to individual printers. Anyone who has the value of a key can submit requests as your account. Share keys only with the people who are developing integrations, and replace them periodically according to your security practices.

Clicking , the tools icon, opens a menu from which you can refresh the information in the table and manage the table columns.