init(options)
retornos Promise<SpreeAISDK | null>. Em caso de sucesso, o objeto expõe renderTryOnButton(options): Promise<void>. Verifique se há nulo antes de renderizar.
| Opção | Tipo | Padrão | Objetivo |
|---|---|---|---|
clientId | string | Obrigatório | Identificador de cliente do navegador emitido. |
baseApiURL | string | https://api.spreeai.com | Origem da API aprovada. Altere apenas para um ambiente emitido. |
baseURL | string | https://vton.spreeai.com | Origem de provador hospedado aprovado. |
partnerId não é uma opção de inicialização na v3. O parceiro é resolvido a partir do cliente autenticado. Nenhum método de renderização de dimensionamento independente é retornado.
renderTryOnButton(options)
| Opção | Tipo | Padrão/requisito | Objetivo |
|---|---|---|---|
elementId | string | Obrigatório | ID do elemento host existente. |
garments | GarmentInput[] | Escolha necessária | Entrada de vestuário recomendada. Use uma matriz não vazia. |
garmentId | string | Alternativa obsoleta | Entrada legada de peça única. Prefira roupas. |
variant | VariantOptions | Obsoleto | Filtro legado com garmentId; prefira a variante por item. |
className | string | Opcional | Classe de botão adicional. |
button | { text?: string } | Opcional | Etiqueta do botão; substituído por features.tryOnButton.text. |
features | TryOnFeatures | Opcional | Configuração de estilo de botão. |
events | TryOnButtonEvents | Opcional | Clique e adicione manipuladores ao carrinho. |
enableAddToCart | boolean | false | Exiba a funcionalidade adicionar ao carrinho. Implemente o manipulador. |
enableSizingRecommendation | boolean | false | Solicite recomendações de tamanho na prova. |
showSizes | boolean | false | Mostrar availableSizes fornecido. |
showPrices | boolean | false | Mostrar preço fornecido. |
defaultUnits | "metric" | "imperial" | Opcional | Sistema de unidades iniciais para medições de perfil. |
GarmentInput
| Campo | Tipo | Objetivo |
|---|---|---|
garmentId | string | Identificador de vestuário SPREEAI obrigatório. |
variant | VariantOptions | Filtro opcional de cor, ajuste, gênero ou estilo. |
availableSizes | string[] | Etiquetas opcionais de tamanho de exibição atual. |
price | string | Preço de exibição opcional, mostrado conforme fornecido. |
Validação e substituto
Para uma única peça de vestuário, a elegibilidade e qualquer variante fixada são verificadas antes da renderização. Solicitações de várias peças procuram uma roupa que combine disponível. Se nada for encontrado, o SDK valida e renderiza a primeira peça de vestuário. Se a validação falhar, nenhum botão será renderizado e o motivo será registrado no console.
Retornos de chamada
| Retorno de chamada | Carga útil |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", vestuário, setIsLoading, closePopUp, onError |
As roupas do carrinho contêm o necessário id, partner_id, available e name, mais opcional description e outros dados. Valide antes de mapear para seu carrinho. Veja implementação de carrinho e estilo de botão para exemplos.
Não faz parte desta superfície
Nenhuma opção documentada por visualização, iniciador de comparação independente ou método de dimensionamento independente são expostos no SDK v3.0.0 retornado. features.loadingScreen foi removido. Não infira métodos que podem ser chamados de tipos exportados restantes ou comentários obsoletos.