init(options)
повернення Promise<SpreeAISDK | null>. При успіху об'єкт викривається renderTryOnButton(options): Promise<void>. Перевірте наявність null перед рендерингом.
| Варіант | Тип | За замовчуванням | призначення |
|---|---|---|---|
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 та інші дані. Перевірте перед зіставленням із кошиком. див реалізація візка і стиль кнопки для прикладів.
Не є частиною цієї поверхні
Немає задокументованих перемикачів для кожного перегляду, окремої панелі запуску порівняння чи окремого методу визначення розміру, що повертається версії 3.0.0 SDK. features.loadingScreen було видалено. Не виводьте викликані методи із залишків експортованих типів або застарілих коментарів.