什么是 SAP Commerce Cloud SmartEdit 的 preview API

Preview API使得SmartEdit能够将商户网站加载到请求的体验环境上的iframe中。体验环境是指特定站点、目录和目录版本的商户网站，并且还可以是指定的语言、日期和时间。

为了以指定的体验环境呈现商户网站，SmartEdit将请求的商户网站加载到请求的体验环境的iframe中。

为了在请求的体验环境中加载商户网站，SmartEdit框架执行以下操作：

• 向预览API发送请求的体验环境的POST请求，并从中获取预览 ticket ID。
• 使用附加了/cx-preview的URI和具有 preview ticket ID作为值的cmsTicketId请求参数，调用体验环境的商户网站首页。
• 将请求的页面加载到iframe中。

下面的负载必须发布到 /previewwebservices/v1/preview：

{
"catalog":"apparel-ukContentCatalog",
"catalogVersion":"Staged",
"language":"en",
"resourcePath":"/the/path/to/my/storefront/site"
"time": "2016-12-20T08:51:36-0500",
"catalogVersions" : [{
      "catalog" : "apparelProductCatalog",
      "catalogVersion" : "Online"
   }, {
      "catalog" : "apparel-ukContentCatalog",
      "catalogVersion" : "Staged"
   }]
}

例子：

response 会返回一个 ticket ID：

然后下一个 HTTP 请求会附带上这个 ticketID：

http://localhost:4200/electronics-spa/en/USD/cx-preview?cmsTi...

在SAP Commerce Cloud Spartacus UI中，请求http://localhost:4200/electronics-spa/en/USD/cx-preview?cmsTi...中的"cx-preview"是一个特殊的标识符，用于指示进行预览操作。

"cx-preview"作为URI路径的一部分，用于告知系统将请求定向到预览模式。它用于区分预览模式和常规模式之间的请求，以便系统能够根据请求类型进行相应的处理。

在Spartacus UI中，预览模式允许用户在编辑过程中查看更改后的网站外观和功能。通过使用"cx-preview"标识符，可以将请求定向到预览环境，以便在编辑器中进行实时预览。

请求中的"en"表示请求的语言版本，"USD"表示请求的货币代码，而"cmsTicketId"是一个预览票据ID，用于在预览环境中唯一标识该次预览操作。

通过在URI中添加"cx-preview"，系统能够识别请求的预览模式，并根据该模式加载相应的内容和功能。这使得用户可以在编辑过程中查看并测试其所做的更改，并确保最终的页面呈现符合预期。

总而言之，"cx-preview"作为请求中的一部分，用于指示SAP Commerce Cloud Spartacus UI进入预览模式，以便用户可以实时查看和测试其所做的更改。这为用户提供了一个可靠的方式来验证和调整页面的外观和功能，以满足其需求。