init(options)
returneringer Promise<SpreeAISDK | null>. Ved succes afslører objektet renderTryOnButton(options): Promise<void>. Tjek for nul før gengivelse.
| Mulighed | Type | Misligholdelse | Formål |
|---|---|---|---|
clientId | string | Påkrævet | Udstedt browser-klient-id. |
baseApiURL | string | https://api.spreeai.com | Godkendt API-oprindelse. Skift kun for et udstedt miljø. |
baseURL | string | https://vton.spreeai.com | Godkendt hosted fitting-room oprindelse. |
partnerId er ikke en init-indstilling i v3. Partneren løses fra den godkendte klient. Ingen selvstændig størrelsesgengivelsesmetode returneres.
renderTryOnButton(options)
| Mulighed | Type | Standard / krav | Formål |
|---|---|---|---|
elementId | string | Påkrævet | ID for det eksisterende værtselement. |
garments | GarmentInput[] | Påkrævet valg | Anbefalet beklædningsgenstand. Brug et ikke-tomt array. |
garmentId | string | Forældet alternativ | Ældre enkeltbeklædningsgenstand. Foretrækker tøj. |
variant | VariantOptions | Forældet | Ældre filter med garmentId; foretrækker en variant pr. |
className | string | Valgfri | Ekstra knapklasse. |
button | { text?: string } | Valgfri | Knap etiket; tilsidesat af features.tryOnButton.text. |
features | TryOnFeatures | Valgfri | Knapstylingkonfiguration. |
events | TryOnButtonEvents | Valgfri | Klik og læg til kurv-handlere. |
enableAddToCart | boolean | false | Vis tilføjelsesvognsfunktionaliteten. Implementer handleren. |
enableSizingRecommendation | boolean | false | Anmod om størrelsesanbefalinger i prøve-på. |
showSizes | boolean | false | Vis leveret availableSizes. |
showPrices | boolean | false | Vis udleveret pris. |
defaultUnits | "metric" | "imperial" | Valgfri | Startenhedssystem til profilmålinger. |
GarmentInput
| Felt | Type | Formål |
|---|---|---|
garmentId | string | Nødvendig SPREEAI beklædningsidentifikation. |
variant | VariantOptions | Valgfrit farve-, pasform-, køn- eller stilfilter. |
availableSizes | string[] | Valgfri aktuelle skærmstørrelsesetiketter. |
price | string | Valgfri displaypris, vist som leveret. |
Validering og fallback
For en enkelt beklædningsgenstand kontrolleres berettigelse og enhver fastgjort variant før gengivelse. Forespørgsler om flere beklædningsgenstande leder efter et tilgængeligt matchende outfit. Hvis ingen findes, validerer og gengiver SDK'et den første beklædningsgenstand i stedet. Hvis valideringen mislykkes, gengives ingen knap, og årsagen logges på konsollen.
Tilbagekald
| Tilbagekald | Nyttelast |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", tøj, setIsLoading, closePopUp, onError |
Vogntøj indeholder påkrævet id, partner_id, available og name, plus valgfrit description og andre data. Valider før kortlægning til din indkøbskurv. Se vogn implementering og knapstyling for eksempler.
Ikke en del af denne overflade
Ingen dokumenterede per-view-switche, selvstændig Compare launcher eller selvstændig størrelsesmetode er eksponeret på den returnerede v3.0.0 SDK. features.loadingScreen er blevet fjernet. Udled ikke kaldbare metoder fra resterende eksporterede typer eller forældede kommentarer.