認証

Version: 4.2
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

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

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

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

重要

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

認証スキーム

使用される認証スキームは、API によって異なります。

  • X-GQL-Token (GraphQL API の場合)。
  • JWT ベアラー (その他の API の場合)。

詳細については、「API」を参照してください。

スコープ

スコープは、認証 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 のすべてのコンテンツへのアクセスを認証します。つまり、このキーには content-#everything# スコープがあります。
  • コンテンツ コレクションで作成した API キーは、そのコンテンツ コレクションへのアクセスのみを認証します。つまり、このキーにはそのコンテンツ コレクションに限定された content- スコープがあります。

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

警告

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

重要

API キーを初めて作成する場合、事前に次の操作を行う必要があります。

  1. コンテンツの公開を有効にします
  2. スキーマを公開します (「メンバーの公開」または「エンティティ定義の公開」を参照してください)。
  3. バックグラウンド プロセスが完了するのを待ちます。

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

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

キーの目的 (手順 4) は、audience スコープに対応しています。

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

警告

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

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

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

キーの目的 (手順 4) は、audience スコープに対応しています。

何かフィードバックはありますか?

この記事を改善するための提案がある場合は、