アドミン API キーの概要

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：3分

    • 管理 API 呼び出しを使用すると、管理 UI インターフェイスとブラウザーを使用せずに管理機能にアクセスできます。

    CPQ は、ブラウザーや CPQ アドミンインターフェイスを使用する代わりに、API 呼び出しを介してアドミン機能にアクセスするために使用できるアドミン API キーを提供します。

    CPQ管理 API キーの概要については、次のビデオをご覧ください。

    管理 API キー

    アドミン API キーページ

    CPQ で [アドミン API キー] ページにアクセスするには、矢印をクリックしてアドミンの [ユーティリティ] セクションCPQ展開します。メニューに [アドミン API キー] タブが表示されます。

    管理キー

    新しいアドミン API キーを追加

    新しいアドミン API キーを追加するには、画面上部の [ 新規 ] をクリックします。

    アドミンキーを追加

    すべてのパラメーターが必須です。

    1. 名前:アドミン API キーの名前
    2. ユーザー ID
    3. 有効期限:キーの有効期限
    4. 権限:キーに割り当てられた権限

    [保存] をクリックする前に、ユースケースに適した権限を選択し てください。

    アドミン API キー権限

    API キーの権限

    1. 読み取り (必須、デフォルト):読み取り専用アクセス、通常は GET 要求用
    2. 編集:フィールドやルールを含むほとんどのオブジェクトに対する作成、読み取り、更新、および削除アクセス権
    3. 展開:詳細計画の展開と展開履歴へのアクセスを許可します
    4. 一括:管理テーブルなどのデータをインポートしたりエクスポートしたりできます。 CPQ
    5. アドミン:すべてのアドミン機能に対する全権限
    6. エンドユーザーデータ:エンドユーザーデータ API へのアクセス

    権限の割り当てが完了したら、[ 保存] をクリックします。ダイアログボックスが更新され、新しいアドミン API キーが表示されます。

    API キーを追加

    1. アドミン API キーの表示
    2. キーをクリップボードにコピーする
    3. ダイアログボックスを閉じる
    重要:
    アドミン API キーは、作成時にのみコピーできます。必ずキーをコピーして保存してください。

    API キーを使用したアドミン API へのアクセス

    API 要求でアドミン API キーを使用するには、ベアラートークン認証で API キーを使用します。

    • ヘッダー:認証ヘッダー
    • キー:authorization
    • 値:ベアラー <管理 API キー>

    ヘッダーの例:

    authorization:ベアラー Qda_UdoiYipb15Le11En8axEuN71FA6Vt_cw

    アドミン API キーを使用する場合は、さまざまなエンドポイントを使用してアドミン API にアクセスします。

    • 一般的な管理エンドポイント (/a/Admin/...) の場合、使用するエンドポイントは (/api/Admin/...) です。

      例 (ルールのリストの取得):

      • アドミン UI での API 呼び出し: /a/Admin/v3/rules?page=0&size=100&sort=modified%2CDESC
      • アドミンキーを使用した API 呼び出し: /api/Admin/v3/rules?page=0&size=100&sort=modified%2CDESC
    • 管理対象テーブルのエンドポイント (/a/managed_tables/...) の場合、API キーを使用してアクセスするときに使用するエンドポイントは (/api/managedTables/...) です。

      例 (管理対象テーブルのスキーマの取得):

      • アドミン UI での API 呼び出し: /a/managed_tables/v1/managedTables/{tableName}/metadata
      • アドミンキーを使用した API 呼び出し: /api/managedTables/v1/managedTables/{tableName}/metadata