チュートリアル: オーサリングAPIと管理APIへの要求の有効化と承認

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

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

オーサリングと管理APIは、インタラクティブなブラウザベースのGraphQL IDEまたはHTTPリクエストを使用して探索できます。GraphQL Authoring and Management APIに対してプログラムでクエリを実行するか、GraphQL IDEを使用してクエリを実行するには、承認が必要です。

このチュートリアルでは、次の方法について説明します。

  • GraphQL IDEを有効にする

  • アクセストークンを取得する

  • GraphQL IDEを承認する

  • HTTP要求の承認

GraphQL IDEを有効にする

IDEを使用するには、少なくともsitecore\Sitecore Client Usersロールに属している必要があります。

GraphQL IDEを使用する前に、設定で有効にする必要があります。

GraphQL IDEを有効にするには:

  • Sitecore設定パッチ ファイルで、次の設定を追加します。

    RequestResponse
    <setting name="GraphQL.Enabled" value="true" />
<setting name="GraphQL.ExposePlayground" value="true" />
    大事な

    GraphQL IDEは、非本番環境でのみ有効にすることをお勧めします。

アクセストークンを取得する

オーサリングおよび管理APIエンドポイントに対する操作を実行するGraphQL IDEまたはHTTP要求を許可するには、アクセス トークンを取得する必要があります。

アクセストークンを取得するには:

  1. Sitecore Identity Serverからベアラー タイプのアクセス トークンを取得するコントローラーを設定します。

  2. ブラウザでコントローラーに移動します。認証が成功すると、アクセストークンがページに表示されます。

  3. Access token値をコピーします。

GraphQL IDEを承認する

GraphQL IDEでクエリとミューテーションを実行する前に、IDE操作の実行を許可する必要があります。

GraphQL IDEを認証するには:

  1. ブラウザでhttps://<your-server>/sitecore/api/authoring/graphql/playground/でIDEを開きます。

  2. IDEの左下ペインの「 HTTP Headers 」タブで、次の形式で認証ヘッダーを追加します。

    RequestResponse
    {
    "Authorization": "Bearer <your-token>"
}

  3. IDEのエンドポイントフィールド( Historyタブの右側)で、エンドポイントがhttps://<your-instance>/sitecore/api/authoring/graphql/v1/であることを確認します。

  4. クエリを実行して設定を確認します。例えば：

    RequestResponse
    query {
  sites {
    name
  }
}

HTTP要求の承認

オーサリングおよび管理APIエンドポイントに対するHTTP要求には、承認が必要です。

HTTPリクエストを認証するには:

  • Bearer認証スキームを含むHTTP Authorizationヘッダーをリクエストヘッダーに追加します。<access-token>プレースホルダーをアクセス トークンの値に置き換えます。例えば：

    RequestResponse
    {
    headers: [
        { "Authorization": "Bearer <access-token>" }
    ]
}

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

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