logo

認証

Preview APIDelivery API のいずれにアクセスする場合も、認証のための API キーが必要です。

Preview API と Delivery API のそれぞれのリクエスト ヘッダーに X-GQL-Token パラメータとして認証キーを入力してください。

キーを作成するには、トークン API を使用するか、Sitecore Content Hub™ UI を使用します。

重要

認証キーは静的で、有効期限はありませんが、取り消すことはできます。

スコープ

スコープは、認証 API キーのアクセス範囲を制限します。 スコープには次の種類があります。

対象用途
顧客ターゲットAPI へのアクセスを認証します。 Preview API へのアクセスには audience-preview を使用し、 Delivery API へのアクセスには audience-delivery を使用します。
Contentスコープ パラメータの ID で識別されたエンティティへのトップレベルのクエリ アクセスが提供されます。ID は、content- プレフィックス以下のすべてです。 例えば、abc123 という ID には、content-abc123 のスコープが必要です。 個々のエンティティ コンテンツ スコープに加えて、特別な content-#everything# スコープはすべてのコンテンツへのアクセスを許可します。
重要

API キーを生成するときは、audience スコープとcontent スコープを少なくともそれぞれ 1 つずつ定義する必要があります。

UI で API キーを作成する

認証 API キーは、[管理] ページまたはコンテンツ コレクションで作成できます。

重要

[管理] ページで作成した API キー は、Preview API または Delivery API のすべてのコンテンツへのアクセスを認証します。 コンテンツ コレクションで作成した API キーは、そのコンテンツ コレクションへのアクセスのみを認証します。

[管理] ページでキーを作成する

認証 API キーを [管理] ページで作成するには:

  1. メニュー バーで管理 をクリックします。
  2. [管理] ページで、[API キー] をクリックします。
  3. [API キー] ページでキーを追加するには、[+ API キー] をクリックします。
  4. キー名を定義します。
  5. キーの目的を選択します (Delivery または Preview)。
  6. [作成] をクリックします。
  7. 生成されたキーをコピーして、将来使用するために保存します。
警告

  • スーパーユーザーのみ [管理] ページで API キーを作成できます。
  • 作成したキーは後で取得できないため、必ず保存してください。

コンテンツ コレクションでキーを作成する

コンテンツ コレクションで認証 API キーを作成するには:

  1. メニューバーで [コンテンツ] をクリックし、[コンテンツコレクション] を選択します。
  2. [コンテンツ コレクション] ページで、目的のコンテンツ コレクションをクリックします。
  3. コンテンツ コレクションの詳細ページで、[その他アクション] をクリックします。
  4. [API キー] をクリックします。
  5. [API キー] 画面でキーを追加するには、[+ API キー] をクリックします。
  6. キー名を定義します。
  7. キーの目的を選択します (Delivery または Preview)。
  8. [作成] をクリックします。
  9. 生成されたキーをコピーして、将来使用するために保存します。
警告

コンテンツ コレクションのための API キーの作成、使用、管理を行うには、適切な役割が必要です。 作成したキーは後で取得できないため、必ず保存してください。

Can we improve this article ? Provide feedback