コマースオペレーションAPI
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
CommerceOps APIはCommerce Service APIのサブセットであり、Sitecore XC実装の管理におけるDevOpsロールをサポートすることを目的としています。これには、環境とグローバル ポリシーを作成および管理する方法が含まれています。
Postman DevOpsコレクションに含まれるサンプルAPI要求は、CommerceOPS APIアクションを実行します。
CommerceOpsService API
CommerceOps APIアクションには、次のものが含まれます。
|
アクション |
形容 |
|---|---|
|
ブートストラップ |
ソースディレクトリ(wwwroot/data/environments)から環境のメタデータを完全に再読み込みします。セキュリティ上の理由から、これはCommerce Engine (CommerceOps) の内部インスタンスから行う必要があります。 メタデータには、グローバルおよび環境固有のポリシーとポリシー・セットが含まれます。 これにより、環境にアーティファクトが追加または削除されるわけではないことに注意してください。ブートストラップはメタデータのみを更新します。 見本: http://{{ServiceHost}}/{{OpsApi}}/Bootstrap() |
|
クリーンエンバイロメント |
Commerce環境からすべてのアーティファクトを削除します。クリーニングする環境は、「Environment」というヘッダーとして渡されます。空の環境を渡すと、すべての環境のメタデータが格納されているグローバル環境が完全にクリアされます。 見本: http://{{ServiceHost}}/{{OpsApi}}/CleanEnvironment() |
|
環境の初期化 |
空のEntityStoreから指定したCommerce環境を初期化し、必要なコンポーネントを追加します。 見本: http://{{ServiceHost}}/{{OpsApi}}/InitializeEnvironment(environment='{{Environment}}') |
|
GetEnvironment(環境の取得) |
1つの名前付きCommerce環境を取得します。 見本: http://{{ServiceHost}}/{{OpsApi}}/Environments ('Entity-CommerceEnvironment-Habitat') |
|
インポート環境 |
エクスポートされた未加工の環境JSON文字列からCommerce環境をインポートします。これにより、指定した環境のメタデータのみがインポートおよび初期化されます。 見本: http://{{ServiceHost}}/{{OpsApi}}/ImportEnvironment() |
|
エクスポート環境 |
Commerce環境をJSONにエクスポートします。 見本: http://{{ServiceHost}}/{{OpsApi}}/ExportEnvironment(environmentName='{{Environment}}') |
|
リスト環境 |
既知のすべてのCommerce環境の一覧を取得します。 見本: http://{{ServiceHost}}/{{OpsApi}}/Environments |
|
GetApiルート |
現在のAPIルートの一覧を取得します。 見本: http://{{ServiceHost}}/{{OpsApi}}/GetApiRoutes |
CommerceShops APIとCommerceAuthoring APIに関連するアクションについては、Commerceデベロッパー リファレンスで説明されています。