init(options)
výnosy Promise<SpreeAISDK | null>. Při úspěchu se objekt obnaží renderTryOnButton(options): Promise<void>. Před vykreslením zkontrolujte, zda neobsahuje hodnotu null.
| Možnost | Typ | Výchozí | Účel |
|---|---|---|---|
clientId | string | Povinné | Vydán identifikátor klienta prohlížeče. |
baseApiURL | string | https://api.spreeai.com | Schválený původ API. Změna pouze pro vydané prostředí. |
baseURL | string | https://vton.spreeai.com | Schválený původ hostované montážní místnosti. |
partnerId není možnost init ve v3. Partner je vyřešen z ověřeného klienta. Není vrácena žádná samostatná metoda vykreslování velikosti.
renderTryOnButton(options)
| Možnost | Typ | Výchozí / požadavek | Účel |
|---|---|---|---|
elementId | string | Povinné | ID existujícího hostitelského prvku. |
garments | GarmentInput[] | Požadovaná volba | Doporučený vstup oděvu. Použijte neprázdné pole. |
garmentId | string | Zastaralá alternativa | Starší jednodílný vstup. Dávejte přednost oděvům. |
variant | VariantOptions | Zastaralé | Starší filtr s garmentId; preferujte variantu na položku. |
className | string | Volitelný | Další třída tlačítka. |
button | { text?: string } | Volitelný | Štítek tlačítka; přepsáno features.tryOnButton.text. |
features | TryOnFeatures | Volitelný | Konfigurace stylu tlačítka. |
events | TryOnButtonEvents | Volitelný | Manipulátory pro kliknutí a přidání do košíku. |
enableAddToCart | boolean | false | Zobrazit funkci přidání do košíku. Implementujte handler. |
enableSizingRecommendation | boolean | false | Doporučení velikosti si vyžádejte při vyzkoušení. |
showSizes | boolean | false | Zobrazit dodávaný availableSizes. |
showPrices | boolean | false | Zobrazit dodávanou cenu. |
defaultUnits | "metric" | "imperial" | Volitelný | Systém startovacích jednotek pro měření profilu. |
GarmentInput
| pole | Typ | Účel |
|---|---|---|
garmentId | string | Požadovaný identifikátor oděvu SPREEAI. |
variant | VariantOptions | Volitelný filtr barev, střihu, pohlaví nebo stylu. |
availableSizes | string[] | Volitelné štítky aktuální velikosti zobrazení. |
price | string | Volitelná zobrazovaná cena, zobrazená tak, jak je dodávána. |
Ověření a nouzové řešení
U jednoho oděvu se před vykreslením zkontroluje způsobilost a jakákoli připnutá varianta. Požadavky na více oděvů hledají vhodné vhodné oblečení. Pokud není žádný nalezen, SDK místo toho ověří a vykreslí první oděv. Pokud se ověření nezdaří, nevykreslí se žádné tlačítko a důvod se zaprotokoluje do konzole.
Zpětná volání
| Zpětné volání | Užitečné zatížení |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", oděvy, setIsLoading, closePopUp, onError |
Košík oblečení obsahuje povinné id, partner_id, available a name, plus volitelné description a další údaje. Před mapováním do košíku ověřte. Viz implementace košíku a styling tlačítek pro příklady.
Není součástí tohoto povrchu
Na vrácené sadě SDK verze 3.0.0 nejsou vystaveny žádné zdokumentované přepínače jednotlivých zobrazení, samostatný spouštěč porovnání nebo samostatná metoda velikosti. features.loadingScreen byl odstraněn. Neodvozujte volatelné metody ze zbylých exportovaných typů nebo zastaralých komentářů.