API Explorer 23.1

API Explorer ツールでは、アプリケーションデベロッパーが次のいくつかの方法で Open Commerce API をインタラクティブに探索できます。

• API を閲覧およびレビューする。
• リクエストを起動して API をテストする。

この API は Swagger-UI を基盤とし、メタ API によって提供される Swagger 2.0 仕様を使用しています。

API Explorer へのログイン 

• 自分のアカウントにドキュメントユーザーの役割があることを確認します。

• https://api-explorer.commercecloud.salesforce.com に移動します。

• Account Manager を経由して自分自身の認証を行います。

• メタデータから Swagger API スキーマを取得します。Digital API では、クライアント ID とパスワードを使用してクライアントを認証しなければならない場合があります。Digital のメタ API の代わりに、Swagger と互換性のある異なるメタ API を提供した場合、デフォルトの Swagger の動作が適用され、認証情報が必要ありません。

  デモ用のクライアント ID {your_own_client_id} とパスワード {your_own_client_id} を使用して、デフォルトで挿入される URL (https://demo-ocapi.demandware.net/s/-/dw/meta/v1/rest) でデモ用のメタデータにアクセスできます。

  Note

• メタデータが検証されると、API が表示されます。

別のインスタンスの選択 

別のシステムの API Explorer には、次の方法でアクセスできます。

1. ページの上部にあるフィールドにターゲットシステムの URL を入力します。たとえば、インスタンスが sandbox_domain.net にある場合、URL は https://sandbox_domain.net/s/-/dw/meta/v1/rest などのようになります。
2. Authorize (認証) をクリックします。これによって、Available Authorizations (使用可能な認証) のポップアップが開きます。
3. Logout (ログアウト) をクリックします。
4. システムに適切なクライアント ID とパスワードを入力して、Authorize (認証) をクリックします。
5. Dismiss (閉じる) をクリックしてポップアップを閉じます。
6. Explore (閲覧) をクリックして、新しいターゲットシステムからメタデータを読み込みます。

API の閲覧 

ページの上部にあるナビゲーションバーには、特定の API とバージョンを選択するためのドロップダウンリストがあります。API を選択すると、バージョンのドロップダウンで選択可能な値が変わります。OCAPI では、任意のバージョンの Data API、Shop API、または Meta API を閲覧できます。以下に、いくつかの使用例をあげます。

• Shop API の バージョン 23.1 を表示するには:
  1. Select API (API の選択) ドロップダウンから shop を選択します。このアクションによってページが更新され、使用可能な Shop API のバージョンが Select API Version (API バージョンの選択) ドロップダウンに含められます。
  2. Select API Version (API バージョンの選択) ドロップダウンから 23.1 を選択します。このアクションによって、Shop API バージョン 23.1 のリソースが表示されます。
  3. リソースを選択すると、詳細が展開されます。
• GET /catalogs/{catalog_id} 操作を調べます。
  1. Select API (API の選択) ドロップダウンリストから data を選択します。このアクションによってページが更新され、使用可能な Data API のバージョンが Select API Version (API バージョンの選択) ドロップダウンに含められます。
  2. Select API Version (API バージョンの選択) ドロップダウンリストから 23.1 を選択します。このアクションによって、Data API バージョン 23.1 のリソースが表示されます。
  3. catalogs (カタログ) リソースを選択します。リソースが展開され、使用可能なエンドポイントが表示されます。
  4. GET /catalogs/{catalog_id} 操作を選択します。リソースが展開され、このエンドポイントの詳細が表示されます。
     • 実装のメモ
     • Response クラス (ステータスデフォルト) (操作で認証が必要な場合は、このセクションの右側に赤い感嘆符が表示されます。)
       • モデル
       • 例の値
       • レスポンスのコンテンツタイプ
     • パラメーター
     • レスポンスメッセージ

HTTP リクエストの試行 

以下に、Explorer からリクエストを起動する例をあげます。

1. Select API (API の選択) ドロップダウンリストから data を選択します。このアクションによってページが更新され、使用可能な Data API のバージョンが Select API Version (API バージョンの選択) ドロップダウンに含められます。

2. Select API Version (API バージョンの選択) ドロップダウンリストから 23.1 を選択します。このアクションによって、Data API バージョン 23.1 のリソースが表示されます。

3. catalogs (カタログ) リソースを選択します。リソースが展開され、使用可能なエンドポイントが表示されます。

4. GET /catalogs/{catalog_id} 操作を選択します。リソースが展開され、このエンドポイントの詳細が表示されます。

5. catalog_id パラメーターに electronics-catalog を入力します。

6. Try it out! (試行) をクリックして、リクエストを起動します。 リクエストとレスポンスが表示されます。呼び出しが正常に完了すると、HTTP レスポンスコード 200 と、指定したカタログに関する情報が返されます。

   ここに表示される Curl リクエストをコピーして、ターミナルに直接貼り付けることができます。

   Note

Shop API を使用した Sandbox (サンドボックス) に対するリクエストの実行 

Shop API を使用して、特定の Sandbox (サンドボックス) に対して HTTP リクエストを起動することができます。このためには、Sandbox (サンドボックス) のサイト ID (SiteGenesis など) を Write Site Id (サイト ID を記入) フィールドに入力します。

Write Site Id (サイト ID を記入) フィールドは API ドロップダウンから shop を選択した場合にのみ表示されます。

Note

ログアウト 

別のクライアントの認証情報を使用するには、ログアウトしなければならない場合があります。ログアウトするには、次の手順に従います。

1. ページの上部で Authorize (認証) をクリックします。このアクションによって、Available Authorizations (使用可能な認証) ダイアログが開きます。
2. ダイアログで Logout (ログアウト) をクリックします。これによってページが更新されます。