init(options)
devoluciones Promise<SpreeAISDK | null>. Si tiene éxito, el objeto se expone. renderTryOnButton(options): Promise<void>. Verifique si hay nulos antes de renderizar.
| Opción | Tipo | Por defecto | Propósito |
|---|---|---|---|
clientId | string | Requerido | Identificador de cliente del navegador emitido. |
baseApiURL | string | https://api.spreeai.com | Origen API aprobado. Cambie solo para un entorno emitido. |
baseURL | string | https://vton.spreeai.com | Origen probador alojado homologado. |
partnerId no es una opción de inicio en v3. El socio se resuelve a partir del cliente autenticado. No se devuelve ningún método de representación de tamaño independiente.
renderTryOnButton(options)
| Opción | Tipo | Predeterminado/requisito | Propósito |
|---|---|---|---|
elementId | string | Requerido | ID del elemento host existente. |
garments | GarmentInput[] | Elección requerida | Entrada de prenda recomendada. Utilice una matriz no vacía. |
garmentId | string | Alternativa obsoleta | Entrada de prenda única heredada. Prefiere prendas. |
variant | VariantOptions | En desuso | Filtro heredado con garmentId; prefiera la variante por artículo. |
className | string | Opcional | Clase de botón adicional. |
button | { text?: string } | Opcional | Etiqueta de botón; anulado por features.tryOnButton.text. |
features | TryOnFeatures | Opcional | Configuración de estilo de botones. |
events | TryOnButtonEvents | Opcional | Haga clic y agregue controladores al carrito. |
enableAddToCart | boolean | false | Muestra la funcionalidad de agregar al carrito. Implementar el controlador. |
enableSizingRecommendation | boolean | false | Solicite recomendaciones de tallas dentro de la prueba. |
showSizes | boolean | false | Mostrar availableSizes suministrado. |
showPrices | boolean | false | Mostrar precio suministrado. |
defaultUnits | "metric" | "imperial" | Opcional | Sistema de unidad de partida para mediciones de perfiles. |
GarmentInput
| campo | Tipo | Propósito |
|---|---|---|
garmentId | string | Identificador de prenda SPREEAI obligatorio. |
variant | VariantOptions | Filtro opcional de color, ajuste, género o estilo. |
availableSizes | string[] | Etiquetas opcionales de tamaño de visualización actual. |
price | string | Precio de visualización opcional, mostrado tal como se suministra. |
Validación y respaldo
Para una sola prenda, la elegibilidad y cualquier variante fijada se verifican antes de renderizar. Las solicitudes de prendas múltiples buscan un conjunto a juego disponible. Si no se encuentra ninguno, el SDK valida y procesa la primera prenda. Si la validación falla, no se representa ningún botón y el motivo se registra en la consola.
Devoluciones de llamada
| Devolución de llamada | Carga útil |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", prendas, setIsLoading, closePopUp, onError |
Las prendas del carrito contienen lo necesario. id, partner_id, available y name, más opcional description y otros datos. Valide antes de asignar a su carrito. Ver implementación del carrito y estilo de botones para ejemplos.
No forma parte de esta superficie.
No se exponen cambios por vista documentados, iniciador de comparación independiente ni método de dimensionamiento independiente en el SDK v3.0.0 devuelto. features.loadingScreen ha sido eliminado. No infiera métodos invocables a partir de tipos exportados sobrantes o comentarios obsoletos.