init(options)
回报 Promise<SpreeAISDK | null>。成功后,对象会暴露 renderTryOnButton(options): Promise<void>。渲染前检查是否为空。
| 选项 | 类型 | 默认 | 目的 |
|---|---|---|---|
clientId | string | 必填 | 发出浏览器客户端标识符。 |
baseApiURL | string | https://api.spreeai.com | 批准的 API 来源。仅针对已发布的环境进行更改。 |
baseURL | string | https://vton.spreeai.com | 经批准的托管试衣间起源。 |
partnerId 不是 v3 中的初始化选项。合作伙伴是从经过身份验证的客户端解析的。不返回独立的大小调整渲染方法。
renderTryOnButton(options)
| 选项 | 类型 | 默认/要求 | 目的 |
|---|---|---|---|
elementId | string | 必填 | 现有宿主元素的 ID。 |
garments | GarmentInput[] | 必选 | 推荐服装输入。使用非空数组。 |
garmentId | string | 已弃用的替代方案 | 传统的单件服装输入。更喜欢服装。 |
variant | VariantOptions | 已弃用 | 传统滤波器采用 garmentId;更喜欢每个项目的变体。 |
className | string | 可选 | 附加按钮类。 |
button | { text?: string } | 可选 | 按钮标签;被 features.tryOnButton.text 覆盖。 |
features | TryOnFeatures | 可选 | 按钮样式配置。 |
events | TryOnButtonEvents | 可选 | 单击并添加到购物车处理程序。 |
enableAddToCart | boolean | false | 显示添加到购物车功能。实施处理程序。 |
enableSizingRecommendation | boolean | false | 在试穿时索取尺码建议。 |
showSizes | boolean | false | 显示提供的 availableSizes。 |
showPrices | boolean | false | 显示供货价格。 |
defaultUnits | "metric" | "imperial" | 可选 | 轮廓测量的起始单位系统。 |
GarmentInput
| 领域 | 类型 | 目的 |
|---|---|---|
garmentId | string | 必需的 SPREEAI 服装标识符。 |
variant | VariantOptions | 可选颜色、款式、性别或风格过滤器。 |
availableSizes | string[] | 可选的当前显示尺寸标签。 |
price | string | 可选显示价格,如提供的那样。 |
验证和回退
对于单件服装,在渲染之前会检查资格和任何固定的变体。多服装请求寻找可用的配套服装。如果未找到,SDK 会验证并渲染第一件服装。如果验证失败,则不会呈现任何按钮,并将原因记录到控制台。
回调
| 回调 | 有效载荷 |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", 服装, setIsLoading, closePopUp, onError |
购物车服装包含所需的 id, partner_id, available 和 name,加上可选的 description 和其他数据。在映射到您的购物车之前进行验证。参见 购物车实施 和 按钮样式 例如。
不属于该表面的一部分
返回的 v3.0.0 SDK 上未公开记录的按视图切换、独立比较启动器或独立大小调整方法。 features.loadingScreen 已被删除。不要从剩余的导出类型或过时的注释中推断出可调用方法。