認証

プレビューAPIとDelivery APIにアクセスするには、APIキーが必要です。初めてAPIキーを作成する前に、以下の条件を満たさなければなりません:

1. コンテンツ公開を有効にしてください。
2. スキーマを公開してください。
3. バックグラウンドプロセスが終わるのを待ちましょう。

!注認証鍵は静的で期限切れにはなりませんが、取り消すことができます。

APIキーを作成する際に、ユーザーがアクセスできるコンテンツのスコープを設定できます。

範囲

概要

聴衆

これにより、キーがどのAPIにアクセスできるかが決まります。プレビュー APIにアクセスするには audience-preview 、 audience-delivery を使ってデリバリー APIにアクセスしてください。

内容

これにより、 スコープパラメータのIDで識別されたエンティティ( content- プレフィックスの後に続くすべてのエンティティ)へのトップレベルのクエリアクセスが提供されます。例えば、 ID fruitful でコンテンツコレクションにアクセスするには、スコープ content-#fruitful#が必要です。 content-#everything# スコープはすべてのコンテンツへのアクセスを可能にします。

!重要APIキーを生成する際には、少なくとも1つの オーディエンス スコープと1つのコンテンツ スコープを定義すべきです。

トークンAPIまたはSitecore Content HubからAPIキーを作成できます。Content Hubでは、以下の方法からAPIキーを作成できます。

• 管理ページ。管理ページから作成されたAPIキーにはcontent-#everything#スコープがあります。
• コンテンツコレクション詳細ページ。コンテンツコレクション詳細ページから作成されたAPIキーは、そのコンテンツコレクションに限定された範囲 content- です。