init(options)
resi Promise<SpreeAISDK | null>. In caso di successo, l'oggetto si espone renderTryOnButton(options): Promise<void>. Verificare la presenza di null prima del rendering.
| Opzione | Digitare | Predefinito | Scopo |
|---|---|---|---|
clientId | string | Obbligatorio | Identificatore del client del browser emesso. |
baseApiURL | string | https://api.spreeai.com | Origine API approvata. Modifica solo per un ambiente emesso. |
baseURL | string | https://vton.spreeai.com | Origine del camerino ospitata approvata. |
partnerId non è un'opzione init nella v3. Il partner viene risolto dal client autenticato. Non viene restituito alcun metodo di rendering del dimensionamento autonomo.
renderTryOnButton(options)
| Opzione | Digitare | Predefinito/requisito | Scopo |
|---|---|---|---|
elementId | string | Obbligatorio | ID dell'elemento host esistente. |
garments | GarmentInput[] | Scelta obbligata | Ingresso indumento consigliato. Utilizza un array non vuoto. |
garmentId | string | Alternativa deprecata | Ingresso legacy a capo singolo. Preferire gli indumenti. |
variant | VariantOptions | Deprecato | Filtro legacy con garmentId; preferisci la variante per articolo. |
className | string | Opzionale | Classe di pulsanti aggiuntiva. |
button | { text?: string } | Opzionale | Etichetta del pulsante; sovrascritto da features.tryOnButton.text. |
features | TryOnFeatures | Opzionale | Configurazione dello stile dei pulsanti. |
events | TryOnButtonEvents | Opzionale | Gestori di clic e aggiunta al carrello. |
enableAddToCart | boolean | false | Visualizza la funzionalità aggiungi al carrello. Implementare il gestore. |
enableSizingRecommendation | boolean | false | Richiedi consigli sulle taglie durante la prova. |
showSizes | boolean | false | Mostra availableSizes in dotazione. |
showPrices | boolean | false | Mostra il prezzo fornito. |
defaultUnits | "metric" | "imperial" | Opzionale | Sistema di unità di partenza per la misurazione dei profili. |
GarmentInput
| Campo | Digitare | Scopo |
|---|---|---|
garmentId | string | Identificatore dell'indumento SPREEAI obbligatorio. |
variant | VariantOptions | Filtro opzionale per colore, vestibilità, sesso o stile. |
availableSizes | string[] | Etichette facoltative per le dimensioni del display corrente. |
price | string | Prezzo visualizzato opzionale, mostrato come fornito. |
Validazione e fallback
Per un singolo capo, l'idoneità e qualsiasi variante fissata vengono verificate prima del rendering. Le richieste multi-indumento cercano un outfit coordinato disponibile. Se non ne viene trovato nessuno, l'SDK convalida ed esegue invece il rendering del primo capo. Se la convalida fallisce, non viene visualizzato alcun pulsante e il motivo viene registrato nella console.
Richiamate
| Richiamata | Carico utile |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", indumenti, setIsLoading, closePopUp, onError |
Il carrello contiene gli indumenti richiesti id, partner_id, available E name, più facoltativo description e altri dati. Convalida prima della mappatura al tuo carrello. Vedi implementazione del carrello E stile dei pulsanti per esempi.
Non fa parte di questa superficie
Nell'SDK v3.0.0 restituito non sono esposte opzioni documentate per visualizzazione, avvio confronto autonomo o metodo di dimensionamento autonomo. features.loadingScreen è stato rimosso. Non dedurre metodi richiamabili da tipi esportati rimanenti o commenti obsoleti.