APIキータブ

APIキータブは、お使いのアカウントがRICOH Predictive Insightのサブスクリプションを契約している場合にのみご利用いただけます。このタブを表示し、キーを操作するには、Account Administrationへの 管理者 アクセス権が必要です。

タブの上部にある2つのリンクをクリックすると、Data Export APIに関する参照情報が表示されます：

APIキーの使い方入門

Data Export API のヘルプが開きます。ここでは、APIキーの使用を開始するために必要な手順のほか、利用可能なエンドポイント、各エンドポイントが返すフィールド、およびリクエストに適用される制限についてご確認いただけます。

APIエクスプローラーを開く

APIのインタラクティブなドキュメントページが開きます。ここでは、各エンドポイントの確認や、受け付けるパラメータの確認、ブラウザから直接サンプルリクエストを送信することができます。そのページからリクエストを送信するには、APIキーの値が必要となります。

このタブで実行できるアクションは次のとおりです。

• ご自身のアカウントで定義されているすべてのキーとそのプロパティー（名前 、 ステータス 、 有効期限日 など）を表示します。

  このテーブルには、キーの値は表示されません。

• キーを作成してください。

  APIキーを作成をクリックします。キーは通常30秒以内に有効になりますが、多少の遅れが生じる場合があります。

• アカウントのAPIリクエストについて、サブスクリプションの制限に対して監視を行ってください。

  APIキーのテーブルの上にあるボックスには、アカウントの利用プランと、30日間で許可されるAPI呼び出しの最大数が表示されています。過去30日間に何件の電話がかかったかを追跡します。

• 既存のキーの名前、説明、または有効期限を編集します。

  行を右クリックし、APIキーを編集を選択します。キーを編集してもその値は変更されないため、すでにそのキーを使用しているアプリケーションは引き続き正常に動作します。

• キーを回転させて、その値を置き換えます。

  行を右クリックし、APIキーを再生成を選択します。既存の値と新しい値の両方が数日間有効になるよう、重複期間を設定してください。そうすることで、アプリケーションを更新するための時間を確保できます。新しい値が設定されたキーは、通常30秒以内に利用可能になりますが、遅延が生じる場合もあります。

• キーを削除します。

  行を右クリックし、今すぐ削除を選択します。

  注意:
  • キーを削除すると、1分以内にシステムから削除されますが、多少の遅れが生じる可能性があります。削除されたキーは完全に削除されます。APIキーを削除した後に、そのAPIキーを使用してAPIリクエストを実行しようとすると、リクエストは失敗します。
  • キーを削除すると、そのキーのすべてのバージョンが削除されます。キーをローテーションしてから削除すると、重複期間がまだ有効である場合でも、そのキーの両方のバージョンが削除されます。

キーは個々のプリンターに限定されるものではありません。キーの値をお持ちの方ならどなたでも、あなたのアカウントとしてリクエストを送信することができます。キーは、連携機能の開発に携わっている方々にのみ共有し、自社のセキュリティ対策に従って定期的に更新してください。

ツールアイコン（）をクリックすると、メニューが表示され、テーブルの情報を更新したり、テーブル列を管理したりすることができます。