PostmanでサンプルAPI呼び出しを実行する
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
XCソリューションの一部としてパッケージ化されたSitecore.Experience.Commerce.SDKには、Commerce EngineへのRESTベースのAPI呼び出しを実行して機能をテストまたは拡張できるPostmanサンプルが含まれています。 Postmanは、単純なテスト対象領域に対するHTTPレベルの呼び出しと応答を管理するためのツールです。
Sitecore XC Postmanサンプルは、Commerce Engineサービス (Postman RESTクライアントを使用) へのサンプルAPI呼び出しのセットであり、呼び出しパターンと期待される結果を示します。ソリューションの開発には任意のHTTPテスト ツールを使用できますが、Sitecore XCで提供されるサンプルにはPostmanを使用し、選択したHTTPテスト ツールに転送することをお勧めします。
すべてのPostmanサンプルは、Sitecore XCリリース パッケージに含まれるSitecore.Commerce.Engine.SDK .zipファイルのpostmanフォルダーにあります。
Sitecore XC postmanフォルダーには、2つのサンプル環境ファイル (Adventure Works環境とHabitat環境) も含まれています。これらのサンプル環境のいずれかをPostmanにインポートすることも、独自の環境を作成することもできます。
Commerce Business Toolsの外部から (Postmanなどを使用して) Commerce Engine APIを呼び出す場合は、wwwroot\config.jsonファイルの偽造防止保護設定を無効にして、IISを再起動する必要があります。また、これは、Postmanサンプル操作に関連付けられたCommerceロールで行う必要があります。たとえば、Clone Catalog Data操作の偽造防止保護設定を無効にするには、Commerce Engineオーサリング ロールでこれを行う必要があります。また、他のAPI呼び出しを実行する前に、Sitecore Identity Serverに対して認証するためのベアラー トークンを ( GetToken要求を使用して) 取得する必要があります。
これらの手順は、Postmanがインストールされており、アプリケーションの動作に関する基本的な知識があることを前提としています。詳細については、Postmanのドキュメントを参照してください。
Postmanを新規インストールした場合、Commerce Engineから応答を返すには、SSL証明書の検証を無効にする必要があります。これを行うには、PostmanでFile, Settingsをクリックし、SSL certificate verificationをOFFに変えます。
Sitecore XC PostmanサンプルAPI呼び出しを使用するには:
-
Sitecore.Commerce.Engine.SDK.zipパッケージ内のpostmanフォルダーを開き、ShopsまたはDevOpsフォルダーに移動します。
-
Postmanアプリケーションを開き、メイン メニュー バーのImportをクリックします。
-
Sitecore XCコレクション .jsonファイルを[インポートウィンドウにドラッグします。
Sitecore XCコレクション ファイルは、postman\DevOpsフォルダーとpostman\Shopsフォルダー ( Sitecore.Commerce.Engine.SDKパッケージ内) にあります。
-
Postman Collectionsウィンドウで、Authenticationコレクションを展開します。
-
Sitecoreフォルダーを開き、GetTokenを選択し、SENDをクリックしてリクエストを実行します。
Postmanの 本文 ウィンドウにアクセス トークンが表示されると、次のような認証が成功しています。
メモこの例に示されているIdentity Serverのホスト名は、展開によって異なる場合があります。
-
必要に応じて、任意のサンプルAPI呼び出しを実行します。
Sitecore XCに含まれるPostmanコレクションの完全なリストについては、「Sitecore XC Postmanコレクションのリスト 」トピックを参照してください。