init(options)
returnează Promise<SpreeAISDK | null>. La succes, obiectul se expune renderTryOnButton(options): Promise<void>. Verificați null înainte de randare.
| Opțiune | Tip | Implicit | Scop |
|---|---|---|---|
clientId | string | Obligatoriu | Identificatorul client de browser emis. |
baseApiURL | string | https://api.spreeai.com | Origine API aprobată. Schimbați numai pentru un mediu emis. |
baseURL | string | https://vton.spreeai.com | Origine aprobată pentru cabină de probă găzduită. |
partnerId nu este o opțiune init în v3. Partenerul este rezolvat de la clientul autentificat. Nu este returnată nicio metodă de randare de dimensionare independentă.
renderTryOnButton(options)
| Opțiune | Tip | Implicit/cerință | Scop |
|---|---|---|---|
elementId | string | Obligatoriu | ID-ul elementului gazdă existent. |
garments | GarmentInput[] | Alegere obligatorie | Intrare recomandată pentru îmbrăcăminte. Utilizați o matrice nevidă. |
garmentId | string | Alternativă depreciată | Intrare moștenită pentru o singură îmbrăcăminte. Preferați hainele. |
variant | VariantOptions | Depreciat | Filtru Legacy cu garmentId; preferă varianta per articol. |
className | string | Opțional | Clasă suplimentară de butoane. |
button | { text?: string } | Opțional | Etichetă pentru buton; înlocuit de features.tryOnButton.text. |
features | TryOnFeatures | Opțional | Configurație de stil pentru butoane. |
events | TryOnButtonEvents | Opțional | Faceți clic și adăugați în coș. |
enableAddToCart | boolean | false | Afișați funcționalitatea de adăugare în coș. Implementați handlerul. |
enableSizingRecommendation | boolean | false | Solicitați recomandări de mărime în cadrul testului. |
showSizes | boolean | false | Arată availableSizes furnizat. |
showPrices | boolean | false | Arată prețul furnizat. |
defaultUnits | "metric" | "imperial" | Opțional | Sistem de unitate de pornire pentru măsurători de profil. |
GarmentInput
| Câmp | Tip | Scop |
|---|---|---|
garmentId | string | Codul de îmbrăcăminte SPREEAI obligatoriu. |
variant | VariantOptions | Filtru opțional de culoare, potrivire, gen sau stil. |
availableSizes | string[] | Etichete opționale pentru dimensiunea afișajului curent. |
price | string | Preț de afișare opțional, afișat așa cum este furnizat. |
Validare și rezervă
Pentru o singură îmbrăcăminte, eligibilitatea și orice variantă fixată sunt verificate înainte de randare. Solicitările cu mai multe articole de îmbrăcăminte caută o ținută asortată disponibilă. Dacă nu se găsește niciuna, SDK-ul validează și redă în schimb primul articol de îmbrăcăminte. Dacă validarea eșuează, niciun buton nu este redat și motivul este înregistrat în consolă.
Reapeluri
| Apel invers | Sarcină utilă |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", articole de îmbrăcăminte, setIsLoading, closePopUp, onError |
Îmbrăcămintea coșului conține obligatoriu id, partner_id, available şi name, plus opțional description si alte date. Validați înainte de a mapa în coșul dvs. Vezi implementarea cărucioarelor şi stilizarea nasturii pentru exemple.
Nu face parte din această suprafață
Pe SDK-ul v3.0.0 returnat nu sunt expuse comutatoare per-view documentate, lansatorul de comparare independent sau metodă de dimensionare independentă. features.loadingScreen a fost eliminat. Nu deduceți metode apelabile din tipurile exportate rămase sau comentariile învechite.