API認証と承認
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
サブドメイン をお持ちの場合は、認証や認証を行う必要はなく、このセクションは無視できます。サブドメインホストURLにAPI呼び出しを行い、Sitecore SearchのDeveloper Resourcesセクションで取得できます。サブドメインホストを使用するだけで、十分な認証と承認が得られます。
サブドメインがない場合は、Sitecore Search APIにアクセスする前に、自分自身を認証して承認する必要があります。認証を行うときは、有効なユーザーであることをSitecore Searchに伝えます。承認すると、呼び出しAPIにアクセスするための十分な権限があることをSitecore Searchに伝えます。認証と承認を組み合わせることで、お客様とお客様の顧客が安全でセキュアなエクスペリエンスを確保できます。
APIキー方式またはアクセストークン方式を使用して認証できます。 スコープを使用して承認できます。
Sitecore Search API認証および承認プロセスは、次のように流れます。
-
必要なスコープを持つAPIキーを取得します。通常、これは一度だけ行う必要があります。
-
必要に応じて、アクセストークンと更新トークンを生成します。これは、トークンの有効期限が切れるたびに行う必要があります。
-
すべてのリクエストヘッダーでAPIキーまたはアクセストークンを渡します。リクエストごとにこれを行う必要があります。
インジェストAPIはAPIキーのみを受け入れます。アクセストークンは受け入れません。
次のセクションでは、APIキー、アクセストークン、および更新トークンについて詳しく説明します。
APIキー
Sitecore Search APIキーは、一意で安全な52文字の秘密コードです。APIキーには有効期限がありません。
これは、APIキーのサンプルです。 01-90c83624-12f708fa77a1e96a25c4a2afd0f28a4c23ff5252
APIキーを自分で生成することはできません。Sitecore Searchが生成します。APIキーを表示するには、Developer Resources > API Accessをクリックします。
APIキーを使用して、オプションでアクセストークンを生成できます。次に、APIキーまたはアクセストークンをリクエストヘッダーに追加します。
APIキー スコープ
すべてのAPIキーにはスコープが割り当てられています。このスコープによって、アクセスできるREST APIとアクセスできないAPIが決まります。呼び出すAPIに応じて、アカウントマネージャーは必要なスコープをAPIキーに割り当てることができます。
APIキーには、次のスコープの1つ、一部、またはすべてを含めることができます。
-
discover - このスコープは、Search and Recommendation APIの使用を許可します。
-
event - このスコープは、イベントAPIの呼び出しを許可します。
-
ingestion - このスコープは、取り込みAPIを呼び出す権限を与えます。
使用するAPIキーは、呼び出すAPIと一致する必要があります。そうでない場合は、エラーが発生します。たとえば、discoverスコープのみを持つAPIキーを使用してイベントAPIを呼び出すと、HTTP 4XXエラーが発生します。
アクセストークンと更新トークン
アクセストークンは、APIリクエストの認証に使用できる一時的なコードです。更新トークンは、新しいアクセス トークンを取得するために使用できる一時的なコードです。
APIキーを送信するのが安全ではないブラウザなどのセキュリティで保護されていないクライアントから呼び出しを行う場合は、トークンを使用します。
まず、APIキーを使用して、サーバーからSitecore Search認証エンドポイントに呼び出しを行います。応答では、アクセス トークンと更新トークンを取得します。
-
アクセス トークンの有効期限が切れたら、更新トークンを使用して新しいアクセス トークンを取得します。
-
更新トークンの有効期限が切れたら、APIキーを使用して新しいアクセス トークンを取得します。
アクセストークンと更新トークンの有効性は限られています。デフォルトは、アクセストークンの場合は1日、更新トークンの場合は1週間です。有効期間は、デフォルトの金額よりも短く変更できますが、それ以上に変更することはできません
アクセストークンと更新トークンを生成したり、リクエストヘッダーにアクセストークンを追加したりできます。
アクセス トークンのスコープ
アクセストークンと更新トークンは、APIキーからスコープを継承します。たとえば、discoverスコープのAPIキーを使用してアクセストークンを生成したとします。このAPIキーから生成したアクセストークンを使用して、Search and Recommendation APIを呼び出すことができますが、Event APIは呼び出せません。