1. Sitecore Experience Edge for XM

APIキーを作成する

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

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

Experience Edge for XMは複数のAPIを持ち、認証には2つの異なるメカニズムを使用しています。Delivery API以外のExperience Edgeで保護されたAPIのいずれかで操作を実行するには、呼び出しシステムはまずJSON Web Token形式の認証トークンを取得しなければなりません。Delivery IDEとPreview IDEを使用する前に、APIキーを作成しなければなりません。

Delivery IDEのAPIキーを作成する

デリバリー API IDEはデリバリー APIを使用します。デリバリー APIはデリバリープラットフォーム上でホストされるGraphQL APIで、承認済みかつ公開されたコンテンツのみへのアクセスを提供します。デリバリー APIへのすべてのリクエストにはAPIキーで認証する必要があります。

!重要APIキーを作成する前にOAuthを使ってJWTを取得し てください。

APIキーを作成するには:

  • create endpointを呼び出してAPIキーを作成します。必ずスコープを提供し、以下を追加してください:

    • “content-#everything#”

    • “audience-delivery”

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

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

    レスポンスはsc_apikeyヘッダーで渡されるべきAPIキーのトークンです。

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

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

APIキーを作成するには:

  1. Sitecore Servicesクライアント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の動作を反映するためです。

この記事を改善するための提案がある場合は、 お知らせください!