init(options)
zwroty Promise<SpreeAISDK | null>. Po sukcesie obiekt zostaje odsłonięty renderTryOnButton(options): Promise<void>. Przed renderowaniem sprawdź wartość null.
| Opcja | Wpisz | Domyślny | Cel |
|---|---|---|---|
clientId | string | Wymagane | Wydany identyfikator klienta przeglądarki. |
baseApiURL | string | https://api.spreeai.com | Zatwierdzone pochodzenie API. Zmień tylko dla wydanego środowiska. |
baseURL | string | https://vton.spreeai.com | Zatwierdzone pochodzenie z hostowanej przymierzalni. |
partnerId nie jest opcją inicjującą w wersji 3. Partner jest rozpoznawany na podstawie uwierzytelnionego klienta. Nie jest zwracana żadna samodzielna metoda renderowania rozmiaru.
renderTryOnButton(options)
| Opcja | Wpisz | Wartość domyślna / wymaganie | Cel |
|---|---|---|---|
elementId | string | Wymagane | Identyfikator istniejącego elementu hosta. |
garments | GarmentInput[] | Wymagany wybór | Zalecany wkład odzieżowy. Użyj niepustej tablicy. |
garmentId | string | Przestarzała alternatywa | Starsze dane wejściowe dotyczące jednej odzieży. Preferuj ubrania. |
variant | VariantOptions | Przestarzałe | Starszy filtr z garmentId; preferuj wariant dla poszczególnych pozycji. |
className | string | Fakultatywny | Dodatkowa klasa przycisku. |
button | { text?: string } | Fakultatywny | Etykieta przycisku; zastąpiony przez features.tryOnButton.text. |
features | TryOnFeatures | Fakultatywny | Konfiguracja stylizacji przycisków. |
events | TryOnButtonEvents | Fakultatywny | Kliknij i dodaj do koszyka. |
enableAddToCart | boolean | false | Wyświetl funkcję dodawania do koszyka. Zaimplementuj moduł obsługi. |
enableSizingRecommendation | boolean | false | Poproś o zalecenia dotyczące rozmiaru podczas przymierzania. |
showSizes | boolean | false | Pokaż dostarczony availableSizes. |
showPrices | boolean | false | Pokaż podaną cenę. |
defaultUnits | "metric" | "imperial" | Fakultatywny | System jednostek początkowych do pomiarów profili. |
GarmentInput
| Pole | Wpisz | Cel |
|---|---|---|
garmentId | string | Wymagany identyfikator odzieży SPREEAI. |
variant | VariantOptions | Opcjonalny filtr koloru, dopasowania, płci lub stylu. |
availableSizes | string[] | Opcjonalne etykiety aktualnego rozmiaru wyświetlacza. |
price | string | Opcjonalna cena wystawowa, pokazana w stanie dostarczonym. |
Walidacja i powrót
W przypadku pojedynczego elementu garderoby przed renderowaniem sprawdzana jest kwalifikowalność i wszelkie przypięte warianty. Zapytania dotyczące wielu ubrań szukają dostępnego pasującego stroju. Jeśli żaden nie zostanie znaleziony, zestaw SDK weryfikuje i zamiast tego renderuje pierwszą część garderoby. Jeśli weryfikacja nie powiedzie się, żaden przycisk nie zostanie wyświetlony, a przyczyna zostanie zarejestrowana w konsoli.
Oddzwonienia
| Oddzwonienie | Ładunek |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", odzież, setIsLoading, closePopUp, onError |
Koszyk odzieży zawiera wymagane id, partner_id, available I name, plus opcjonalne description i inne dane. Zatwierdź przed mapowaniem do koszyka. Zobacz wdrożenie koszyka I stylizacja guzików dla przykładów.
Nie jest częścią tej powierzchni
W zwróconym zestawie SDK w wersji 3.0.0 nie są widoczne żadne udokumentowane przełączniki poszczególnych widoków, samodzielny program uruchamiający Porównaj ani samodzielna metoda ustalania rozmiaru. features.loadingScreen został usunięty. Nie wnioskuj wywoływalnych metod na podstawie resztek wyeksportowanych typów lub nieaktualnych komentarzy.