APIキーを作成して管理する

APIキーは、データエクスポートAPIへのリクエストを認証するものです。APIキーの作成と管理はAccount Administrationで行い、APIエクスプローラーページやご自身のアプリケーションからリクエストを送信する際には、そのキーを指定します。

Data Export API への各リクエストには、x-api-keyリクエストヘッダーに有効な APIキーを含める必要があります。このキーは、お客様のアカウント（テナント）へのリクエストを認証するものです。

APIキーを作成するには、Account Administrationへの管理者アクセス権が必要です。

このトピックの手順を使用して、次のことを行います：

新しいAPIキーを作成してください。
既存のキーの名前、有効期限、または説明を編集します。
鍵の識別子を変更することなく、その秘密値を置き換えるために鍵をローテーションします。
システムからキーを削除します。

注意: APIキーを作成または更新した際、そのキーが登録され、使用可能になるまでには、わずかな時間がかかります。通常、この時間は1分未満です。

新しいAPIキーを作成するには：
1. Account Administrationの左ペインで、 APIキーをクリックします。
2. APIキーを作成をクリックします。
3. このキーの名前と説明を入力してください。
4. 有効期限日については、今後367日以内の日付をお選びください。
5. ライセンスをご利用の場合は、 APIキーのRPI データエクスポート利用プランを選択してください。
6. 次へをクリックします。
  鍵が生成され、保存されました。
7. コピーをクリックして、生成されたキーをクリップボードにコピーしてください。安全に保管してください。
  
  重要: キーの完全な値は、そのキーが作成されたときにのみ表示されます。それにはもうアクセスできません。その値を紛失した場合は、キーをローテーションして新しいキーを生成する必要があります。
1. キーを保存しましたをクリックして、ダイアログを閉じます。
既存のAPIキーを編集するには：
1. Account Administrationの左ペインで、 APIキーをクリックします。
2. 変更したいキーを探してください。該当するキーの行を右クリックし、APIキーを編集を選択してください。
3. 必要に応じて、名前、有効期限、または説明を更新してください。
  キーを編集しても、キーの値は変更されません。すでにこのキーを使用しているアプリケーションは、変更を加えることなく引き続き動作します。
4. OKをクリックします。
APIキーをローテーションするには：
1. Account Administrationの左ペインで、 APIキーをクリックします。
2. 回転させたいキーを探してください。該当するキーの行を右クリックし、APIキーを再生成を選択してください。
3. 重複期間（日数）を、既存のキーとローテーション後のキーの両方が同時に有効である期間（日数）に設定してください。
4. そのキーに対して、新しい有効期限日を設定します。
5. OKをクリックします。
6. コピーをクリックして、生成されたキーをクリップボードにコピーしてください。安全に保管してください。
  
  重要: キーの完全な値は、そのキーが作成されたときにのみ表示されます。それにはもうアクセスできません。その値を紛失した場合は、キーをローテーションして新しいキーを生成する必要があります。
7. 重複期間が終了する前に、そのキーを使用しているアプリケーション、スクリプト、または保存済みの対話型ドキュメントセッションをすべて更新してください。
システムからキーを削除するには：
1. Account Administrationの左ペインで、 APIキーをクリックします。
2. 回転させたいキーを探してください。該当するキーの行を右クリックし、今すぐ削除を選択してください。
3. ダイアログで、以下を選択してくださいはい、削除します。
  削除は元に戻せないため、この手順が必要です。キーを削除すると、復元することはできません。
4. OKをクリックします。

新しいAPIキーや更新されたAPIキーは、インタラクティブなドキュメントページでData Export APIのテストを行う際や、このAPIにリクエストを送信するあらゆるアプリケーションで使用できます。

RICOH Account Administration

APIキーを作成して管理する

Related information: