ウォークスルー

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

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

HTTPリクエストを通じてAuthoring and Management APIを探索できます。GraphQL Authoring and Management APIをプログラム的にクエリするには承認が必要です。

このウォークスルーでは、以下の方法を説明します:

  • GraphQLを有効にする
  • アクセストークンを取得する
  • HTTPリクエストを認可する

GraphQLを有効にする

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

GraphQLを有効にするには:

  • Sitecoreの設定パッチファイルで、以下の設定を追加してください:

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

Authoring and Management APIエンドポイントに対してHTTPリクエストを操作するために許可するには、アクセストークンを取得する必要があります。

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

  1. Sitecore Identity Serverからベアラータイプのアクセストークンを取得するコントローラを設定しましょう
  2. ブラウザでコントローラーに移動します。認証が成功すると、アクセストークンがページに表示されます。
  3. Access token値をコピーしてください。

HTTPリクエストを認可する

Authoring and Management APIエンドポイントへのすべてのHTTPリクエストは承認されなければなりません。PostmanやInsomniaのようなツールを使ってこれらのリクエストを送信・検証できます

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

  • リクエストヘッダーにBearer認証方式付きのHTTP Authorizationヘッダーを追加します。プレースホルダーをアクセストークンの値に置き換えます。例えば:

    { headers: { "Authorization": "Bearer " }

    }

  • HTTPリクエストの認証をテストするには、クエリを実行してセットアップを確認してください。例えば:

    query { sites{ name } }

ローカルAPI検出のためのベアラートークン

ローカル開発やAPI発見の代替手段として、Identity Serverで軽量なOAuthクライアントを設定し、/connect/tokenエンドポイントから直接トークンを要求することで、カスタムアプリケーションを作成しずにベアラートークンを取得することができますSitecore。

この方法は、Postman、curl、PowerShellなどのツールで一般的に使われ、Authoring and Management APIやGraphQL Playgroundの迅速な実験を可能にします。

!警告この方法はSitecore Identity Serverの設定変更を必要とし、開発やテスト専用の助成金タイプを含む場合があります。本番環境には推奨されません。

本番環境では、このトピックで前述したアプリケーションベースの認可フローを用いてください。

大まかに言えば、このアプローチは以下を含みます:

  • 必要なAPIスコープを備えたクライアント構成をSitecore Identity Serverに追加

  • アクセストークンの申請:

    https:///connect/token

  • APIリクエストで返されたアクセストークンをベアラートークンとして提供する方法:

    Authorization: Bearer <access_token>

このオプションは、局所的な探索やトラブルシューティングのための摩擦を減らすことを目的としています。

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