Postman でのサンプル API 呼び出しの実行

概要

Postman サンプルを使用して Sitecore XC の API 要求を実行する方法。

XC ソリューションの一部としてパッケージ化されている Sitecore.Experience.Commerce.SDK には Postman サンプルが含まれており、Commerce Engine に対する REST ベースの API 呼び出しを実行して、機能をテストまたは拡張できます。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 ロールで実行する必要があります。たとえば、カタログ データのクローン作成操作の偽造防止保護設定を無効にするには、Commerce Engine の Authoring ロールで行う必要があります。また、ベアラー トークンを取得して (GetToken 要求を使用)、Sitecore Identity Server に対して認証を行わないと、他の API 呼び出しを実行することはできません。

ここで説明する手順は、Postman がインストールされていて、アプリケーションの動作に関する基本的な知識があることを前提としています。詳細については、Postman のドキュメントを参照してください。

重要

Postman の新規インストールでは、Commerce Engine からの応答を取得するために、SSL 証明書の検証を無効にする必要があります。これを行うには、Postman で [File]、[Settings] の順にクリックし、[SSL certificate verification] を [OFF] に設定します。

Sitecore XC の Postman サンプル API 呼び出しを使用するには:

  1. Sitecore.Commerce.Engine.SDK .zip パッケージの postman フォルダーを開き、Shops または DevOps フォルダーに移動します。

  2. Postman アプリケーションを開き、メイン メニュー バーの [Import] をクリックします。

    Postman のメイン メニュー バーにある [Import] ボタン。
  3. Sitecore XC コレクションの .json ファイルを [Import] ウィンドウにドラッグします。

    Sitecore XC コレクション ファイルは、postman\DevOps および postman\Shops フォルダー (Sitecore.Commerce.Engine.SDK パッケージ内) にあります。

  4. Postman の [Collections] ペインで、Authentication コレクションを展開します。

  5. Sitecore フォルダーを開き、GetToken を選択して [SEND] をクリックし、要求を実行します。 

    Postman の [Body] ペインにアクセス トークンが表示されれば、認証は成功です。たとえば、次のように表示されます。

    注記

    この例に示されている Identity Server のホスト名は、デプロイによって異なる場合があります。

    Postman の [Body] ペインに表示される認証トークン。
  6. 必要に応じて、任意のサンプル API 呼び出しを実行します。 

Sitecore XC に含まれている Postman コレクションの完全なリストについては、「Sitecore XC の Postman コレクションのリスト」トピックを参照してください。