init(options)
tuotot Promise<SpreeAISDK | null>. Onnistuessaan esine paljastuu renderTryOnButton(options): Promise<void>. Tarkista nolla ennen renderöintiä.
| Vaihtoehto | Kirjoita | Oletus | Tarkoitus |
|---|---|---|---|
clientId | string | Pakollinen | Myönnetty selaimen asiakastunnus. |
baseApiURL | string | https://api.spreeai.com | Hyväksytty API-alkuperä. Muuta vain hyväksyttyä ympäristöä varten. |
baseURL | string | https://vton.spreeai.com | Hyväksytty isännöity sovitushuoneen alkuperä. |
partnerId ei ole aloitusvaihtoehto v3:ssa. Kumppani ratkaistaan todennetusta asiakkaasta. Erillistä koon hahmonnusmenetelmää ei palauteta.
renderTryOnButton(options)
| Vaihtoehto | Kirjoita | Oletus/vaatimus | Tarkoitus |
|---|---|---|---|
elementId | string | Pakollinen | Olemassa olevan isäntäelementin tunnus. |
garments | GarmentInput[] | Pakollinen valinta | Suositeltu vaatesyöttö. Käytä ei-tyhjää taulukkoa. |
garmentId | string | Käytöstä poistettu vaihtoehto | Vanha yhden vaatteen syöttö. Suosi vaatteita. |
variant | VariantOptions | Käytöstä poistettu | Vanha suodatin garmentId; mieluummin tuotekohtaista varianttia. |
className | string | Valinnainen | Lisäpainikeluokka. |
button | { text?: string } | Valinnainen | Painikkeen etiketti; ohittaa features.tryOnButton.text. |
features | TryOnFeatures | Valinnainen | Painikkeiden muotoiluasetukset. |
events | TryOnButtonEvents | Valinnainen | Klikkaa ja lisää ostoskoriin. |
enableAddToCart | boolean | false | Näytä lisää ostoskoriin -toiminto. Toteuta ohjaaja. |
enableSizingRecommendation | boolean | false | Pyydä kokosuosituksia kokeilun sisällä. |
showSizes | boolean | false | Näytä mukana toimitettu availableSizes. |
showPrices | boolean | false | Näytä toimitettu hinta. |
defaultUnits | "metric" | "imperial" | Valinnainen | Aloitusyksikköjärjestelmä profiilimittauksiin. |
GarmentInput
| Kenttä | Kirjoita | Tarkoitus |
|---|---|---|
garmentId | string | Pakollinen SPREEAI-vaatetunniste. |
variant | VariantOptions | Valinnainen väri-, istuvuus-, sukupuoli- tai tyylisuodatin. |
availableSizes | string[] | Valinnaiset nykyiset näyttökoon tarrat. |
price | string | Valinnainen näyttöhinta, joka näkyy toimituksena. |
Validointi ja palautus
Yhden vaatteen kelpoisuus ja kaikki kiinnitetyt variantit tarkistetaan ennen renderöimistä. Useita vaatteita koskevissa pyynnöissä etsitään saatavilla olevaa yhteensopivaa asua. Jos mitään ei löydy, SDK vahvistaa ja renderöi sen sijaan ensimmäisen vaatteen. Jos vahvistus epäonnistuu, painiketta ei näytetä ja syy kirjataan konsoliin.
Takaisinsoittoja
| Takaisinsoitto | Hyötykuorma |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", vaatteet, setIsLoading, closePopUp, onError |
Kärryvaatteet sisältävät pakolliset id, partner_id, available ja name, plus valinnainen description ja muita tietoja. Vahvista ennen kuin yhdistät ostoskoriin. Katso kärryn toteutus ja painikkeiden muotoilu esimerkkejä varten.
Ei osa tätä pintaa
Palautetussa v3.0.0 SDK:ssa ei ole dokumentoituja katselukohtaisia kytkimiä, itsenäistä Vertaa-käynnistysohjelmaa tai erillistä koonmääritysmenetelmää. features.loadingScreen on poistettu. Älä päättele kutsuttavia menetelmiä jäljellä olevista vietyistä tyypeistä tai vanhentuneista kommenteista.