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 已刪除。不要從剩餘的匯出類型或過時的註解中推斷出可呼叫方法。