init(options)
returer Promise<SpreeAISDK | null>. Ved suksess avslører objektet renderTryOnButton(options): Promise<void>. Se etter null før gjengivelse.
| Alternativ | Type | Misligholde | Formål |
|---|---|---|---|
clientId | string | Obligatorisk | Utstedt nettleserklientidentifikator. |
baseApiURL | string | https://api.spreeai.com | Godkjent API-opprinnelse. Endre kun for et utstedt miljø. |
baseURL | string | https://vton.spreeai.com | Godkjent hosted fitting-room origin. |
partnerId er ikke et init-alternativ i v3. Partneren løses fra den autentiserte klienten. Ingen frittstående gjengivelsesmetode for størrelse returneres.
renderTryOnButton(options)
| Alternativ | Type | Standard / krav | Formål |
|---|---|---|---|
elementId | string | Obligatorisk | ID for det eksisterende vertselementet. |
garments | GarmentInput[] | Nødvendig valg | Anbefalt plagginngang. Bruk en ikke-tom array. |
garmentId | string | Utdatert alternativ | Eldre enkeltplagginngang. Foretrekker plagg. |
variant | VariantOptions | Avviklet | Eldre filter med garmentId; foretrekker variant per vare. |
className | string | Valgfri | Ekstra knappeklasse. |
button | { text?: string } | Valgfri | Knapp etikett; overstyrt av features.tryOnButton.text. |
features | TryOnFeatures | Valgfri | Konfigurasjon av knappestil. |
events | TryOnButtonEvents | Valgfri | Klikk og legg i handlekurv-behandlere. |
enableAddToCart | boolean | false | Vis tilleggsfunksjonaliteten. Implementer behandleren. |
enableSizingRecommendation | boolean | false | Be om størrelsesanbefalinger i prøving. |
showSizes | boolean | false | Vis levert availableSizes. |
showPrices | boolean | false | Vis oppgitt pris. |
defaultUnits | "metric" | "imperial" | Valgfri | Startenhetssystem for profilmålinger. |
GarmentInput
| Felt | Type | Formål |
|---|---|---|
garmentId | string | Nødvendig SPREEAI plaggidentifikator. |
variant | VariantOptions | Valgfritt farge-, passform-, kjønns- eller stilfilter. |
availableSizes | string[] | Valgfri gjeldende skjermstørrelsesetiketter. |
price | string | Valgfri visningspris, vist som levert. |
Validering og fallback
For et enkelt plagg kontrolleres kvalifikasjonen og eventuelle festede varianter før gjengivelse. Forespørsler om flere plagg ser etter et tilgjengelig matchende antrekk. Hvis ingen blir funnet, validerer og gjengir SDK det første plagget i stedet. Hvis valideringen mislykkes, blir ingen knapp gjengitt og årsaken logges på konsollen.
Tilbakeringinger
| Tilbakeringing | Nyttelast |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", plagg, setIsLoading, closePopUp, onError |
Handlevogn plagg inneholder nødvendig id, partner_id, available og name, pluss valgfritt description og andre data. Valider før kartlegging til handlekurven din. Se handlevogn implementering og knappstiling for eksempler.
Ikke en del av denne overflaten
Ingen dokumenterte per-view-svitsjer, frittstående Compare launcher eller frittstående størrelsesmetode er eksponert på den returnerte v3.0.0 SDK. features.loadingScreen har blitt fjernet. Ikke utlede anropbare metoder fra gjenværende eksporterte typer eller foreldede kommentarer.