APIキーを作成する

Version: 22.x
日本語翻訳に関する免責事項

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

Experience Edge for XMにはいくつかのAPIがあり、認証に2つの異なるメカニズムを使用します。配信API以外のExperience Edgeで保護されたAPIのいずれかで操作を実行するには、呼び出し元のシステムはまずJSON Webトークン形式の認証トークンを取得する必要があります。配信IDEとプレビュー IDEを使用する前に、APIキーを作成する必要があります。

配信IDEのAPIキーの作成

配信API IDEは配信APIを使用します。配信APIは、配信プラットフォーム上でホストされるGraphQL APIであり、承認済みおよび公開済みのコンテンツにのみアクセスできます。Delivery APIへのすべてのリクエストに対して、APIキーを使用して認証する必要があります。

大事な

APIキーを作成する前に、OAuthを使用してJWTを取得します。

APIキーを作成するには:

  • 作成エンドポイントを呼び出して、APIキーを作成します。必ずスコープを指定し、以下を追加してください。

    • “content-#everything#”

    • “audience-delivery”

    警告

    このトークンは安全な場所に保存してください。Sitecoreはこのトークンを保存せず、作成後にトークンをシステムから取得することはできません。

    RequestResponse
    curl --request POST --url "https://edge.sitecorecloud.io/api/apikey/v1" --header "content-type: application/json" --header "Authorization: Bearer <JWT token>" --data "{ \"CreatedBy\":\"ADN\", \"Label\":\"Website token\", \"Scopes\": [\"content-#everything#\", \"audience-delivery\"] }"

    応答は、sc_apikeyヘッダーで渡す必要があるAPIキーのトークンです。

プレビュー IDEのAPIキーを作成する

プレビュー API IDEは配信IDEと同じ機能を提供しますが、セルフホストのSitecore XMインスタンスのプレビュー APIに対して実行されます。プレビュー エンドポイントのテストUIを使用して、クエリをテストできます。セルフホストのSitecore XMインスタンスのプレビュー エンドポイント (/sitecore/api/graph/edge) はデフォルトで有効になっています。ただし、APIキーを作成し、GraphQLリクエストと共に渡す必要があります。

APIキーを作成するには:

  1. Sitecore Services Client APIキーを作成します。

    メモ

    すでにAPIキーをお持ちの場合があります。たとえば、Next.js dotnet newテンプレートなどのGetting Startedテンプレートを使用している場合です。Experience Edgeプレビュースキーマでのみ使用できるAPIキーを作成する場合は、「 Allowed Controllers 」フィールドで次の項目を指定します。Sitecore.Services.GraphQL.Hosting.Mvc.GraphQLController;GraphQL:/sitecore/api/graph/edge

  2. トークンを生成したら、リクエストのヘッダーでAPIトークンを渡す必要があります。HTTPヘッダー をクリックし、次の形式でトークンを追加します:{"sc_apikey": "YOUR_TOKEN"}これで、データをクエリして返される結果を確認できるようになります。

    手記

    Sitecore Services ClientとSitecore GraphQLは、クエリ文字列を介してAPIキーも受け入れます。ただし、sc_apikey HTTPヘッダーはExperience Edgeの動作を反映しているため、使用することをお勧めします。

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

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