API Keys
Applications that use an API instead of the user interface cannot log in as a user. Instead, each request includes the value of an API key, which identifies the account that the request belongs to. Because the key carries your account identity, requests do not need to supply an account or tenant parameter.
You can define up to ten keys for your account. Many organizations create one key for each application that retrieves data, so that a key can be replaced or deleted without interrupting the other applications. Each key has a name, a description, and an expiration date.
The value of a key is displayed only once, at the moment you create or rotate the key. Account Administration does not store the value in a form that can be displayed again, so you must copy it and store it securely when it is shown. If a value is lost, you rotate the key to generate a new one. Anyone who has the value can submit requests as your account, so protect keys the same way you protect a password. Keys are not restricted to particular printers.
Keys are managed on the API Keys tab. You can change a key's name, description, or expiration date; rotate a key to replace its value while keeping its identity; or delete a key to revoke access immediately.
In RICOH TotalFlow Cloud, API keys are used with the Data Export API, which retrieves printer, job, and printer state information collected by RICOH Predictive Insight. The number of API requests that your account can make, across all keys, is determined by your subscription. Each subscription sets an upper limit for the number of API requests permitted in a rolling 30 day period. If you exceed the number of calls granted by your subscription, no requests are accepted until the total requests for the previous 30 days drop below the subscription limit. To see how many calls your subscription provides and how many you have used in the previous 30 days, consult the API Keys page. If you find that you need more capacity for API requests, ask your Ricoh representative about upgrading your subscription.