init(options)
retours Promise<SpreeAISDK | null>. En cas de succès, l'objet expose renderTryOnButton(options): Promise<void>. Vérifiez null avant le rendu.
| Options | Tapez | Défaut | Objectif |
|---|---|---|---|
clientId | string | Obligatoire | Identifiant client du navigateur émis. |
baseApiURL | string | https://api.spreeai.com | Origine API approuvée. Modification uniquement pour un environnement émis. |
baseURL | string | https://vton.spreeai.com | Origine cabine d'essayage hébergée agréée. |
partnerId n'est pas une option d'initialisation dans la v3. Le partenaire est résolu à partir du client authentifié. Aucune méthode de rendu de dimensionnement autonome n'est renvoyée.
renderTryOnButton(options)
| Options | Tapez | Par défaut/exigence | Objectif |
|---|---|---|---|
elementId | string | Obligatoire | ID de l'élément hôte existant. |
garments | GarmentInput[] | Choix obligatoire | Entrée de vêtement recommandée. Utilisez un tableau non vide. |
garmentId | string | Alternative obsolète | Entrée héritée d’un seul vêtement. Préférez les vêtements. |
variant | VariantOptions | Obsolète | Filtre existant avec garmentId ; préférez la variante par article. |
className | string | Facultatif | Classe de bouton supplémentaire. |
button | { text?: string } | Facultatif | Étiquette du bouton ; remplacé par features.tryOnButton.text. |
features | TryOnFeatures | Facultatif | Configuration du style des boutons. |
events | TryOnButtonEvents | Facultatif | Gestionnaires de clics et d’ajouts au panier. |
enableAddToCart | boolean | false | Affichez la fonctionnalité d'ajout au panier. Implémentez le gestionnaire. |
enableSizingRecommendation | boolean | false | Demandez des recommandations de taille lors de l’essai. |
showSizes | boolean | false | Afficher le availableSizes fourni. |
showPrices | boolean | false | Afficher le prix fourni. |
defaultUnits | "metric" | "imperial" | Facultatif | Système d'unités de départ pour les mesures de profil. |
GarmentInput
| Champ | Tapez | Objectif |
|---|---|---|
garmentId | string | Identificateur de vêtement SPREEAI requis. |
variant | VariantOptions | Filtre facultatif de couleur, de coupe, de sexe ou de style. |
availableSizes | string[] | Étiquettes de taille d’affichage actuelle en option. |
price | string | Prix d’affichage en option, indiqué tel que fourni. |
Validation et repli
Pour un seul vêtement, l'éligibilité et toute variante épinglée sont vérifiées avant le rendu. Les demandes multi-vêtements recherchent une tenue assortie disponible. Si aucun n’est trouvé, le SDK valide et restitue le premier vêtement à la place. Si la validation échoue, aucun bouton n'est affiché et la raison est enregistrée dans la console.
Rappels
| Rappel | Charge utile |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", vêtements, setIsLoading, closePopUp, onError |
Les vêtements du chariot contiennent les éléments requis id, partner_id, available et name, plus facultatif description et d'autres données. Validez avant de mapper sur votre panier. Voir mise en œuvre du panier et style des boutons pour des exemples.
Ne fait pas partie de cette surface
Aucun commutateur par vue documenté, aucun lanceur de comparaison autonome ou méthode de dimensionnement autonome n'est exposé sur le SDK v3.0.0 renvoyé. features.loadingScreen a été supprimé. Ne déduisez pas de méthodes appelables à partir de types exportés restants ou de commentaires obsolètes.