APIキー

ユーザーインターフェースの代わりにAPIを使用するアプリケーションは、ユーザーとしてログインすることはできません。その代わりに、各リクエストには、そのリクエストがどのアカウントに属するかを識別するAPIキーの値が含まれています。キーにはアカウントの識別情報が含まれているため、リクエスト時にアカウントやテナントのパラメータを指定する必要はありません。

アカウントには、最大10個のキーを登録することができます。多くの組織では、データを取得するアプリケーションごとに1つのキーを作成しています。これにより、あるキーを置き換えたり削除したりしても、他のアプリケーションの動作を妨げずに済むようにしています。各キーには、名前、説明、および有効期限が設定されています。

鍵の値は、鍵を作成または更新した瞬間に一度だけ表示されます。Account Administrationでは、その値を再度表示できる形式で保存することはありませんので、表示された際には、その値をコピーして安全に保管する必要があります。値が失われた場合は、鍵を回転させて新しい鍵を生成します。その値をお持ちの方なら誰でも、あなたのアカウントとしてリクエストを送信することができますので、パスワードを保護するのと同じように、鍵を保護してください。キーは特定のプリンターに限定されません。

キーの管理は、APIキータブで行います。キーの名前、説明、有効期限を変更したり、キーをローテーションして識別子を維持したまま値を置き換えたり、キーを削除して直ちにアクセス権を無効にしたりすることができます。

RICOH TotalFlow Cloudでは、APIキーは Data Export API と組み合わせて使用されます。この API は、RICOH Predictive Insightによって収集されたプリンター、ジョブ、およびプリンターの状態情報を取得します。アカウントがすべてのAPIキーを合わせて送信できる API リクエストの数は、ご利用のサブスクリプションによって決まります。各サブスクリプションでは、30日間のローリング期間内に許可されるAPIリクエスト数の上限が設定されています。ご契約で許可されている呼び出し回数を超過した場合、過去30日間のリクエスト総数が契約上限を下回るまで、リクエストは一切受け付けられません。ご契約で利用できる通話回数や、過去30日間の通話利用状況を確認するには、 APIキーのページをご覧ください。APIリクエストの容量が不足しているとお感じの場合は、Ricohの担当者までサブスクリプションのアップグレードについてお問い合わせください。