init(options)
retourneert Promise<SpreeAISDK | null>. Bij succes wordt het object blootgelegd renderTryOnButton(options): Promise<void>. Controleer op nul voordat u het rendert.
| Optie | Typ | Standaard | Doel |
|---|---|---|---|
clientId | string | Vereist | Uitgegeven browserclient-ID. |
baseApiURL | string | https://api.spreeai.com | Goedgekeurde API-oorsprong. Alleen wijzigen voor een uitgegeven omgeving. |
baseURL | string | https://vton.spreeai.com | Goedgekeurde gehoste paskameroorsprong. |
partnerId is geen init-optie in v3. De partner wordt opgelost vanaf de geverifieerde client. Er wordt geen zelfstandige formaatweergavemethode geretourneerd.
renderTryOnButton(options)
| Optie | Typ | Standaard / vereiste | Doel |
|---|---|---|---|
elementId | string | Vereist | ID van het bestaande hostelement. |
garments | GarmentInput[] | Vereiste keuze | Aanbevolen kledinginvoer. Gebruik een niet-lege array. |
garmentId | string | Verouderd alternatief | Oudere input voor één kledingstuk. Geef de voorkeur aan kledingstukken. |
variant | VariantOptions | Afgekeurd | Ouderwetsfilter met garmentId; geef de voorkeur aan een variant per artikel. |
className | string | Optioneel | Extra knopklasse. |
button | { text?: string } | Optioneel | Knooplabel; overschreven door features.tryOnButton.text. |
features | TryOnFeatures | Optioneel | Configuratie van knopstijl. |
events | TryOnButtonEvents | Optioneel | Handlers voor klikken en toevoegen aan winkelwagen. |
enableAddToCart | boolean | false | Geef de add-to-cart-functionaliteit weer. Implementeer de handler. |
enableSizingRecommendation | boolean | false | Vraag maataanbevelingen aan tijdens het passen. |
showSizes | boolean | false | Toon geleverde availableSizes. |
showPrices | boolean | false | Toon geleverde prijs. |
defaultUnits | "metric" | "imperial" | Optioneel | Startunitsysteem voor profielmetingen. |
GarmentInput
| Veld | Typ | Doel |
|---|---|---|
garmentId | string | Vereiste SPREEAI-kledingstukidentificatie. |
variant | VariantOptions | Optioneel kleur-, pasvorm-, geslacht- of stijlfilter. |
availableSizes | string[] | Optionele labels voor huidige displaygrootte. |
price | string | Optionele displayprijs, weergegeven zoals geleverd. |
Validatie en terugval
Voor een enkel kledingstuk worden de geschiktheid en eventuele vastgezette varianten gecontroleerd voordat het wordt weergegeven. Bij verzoeken voor meerdere kledingstukken wordt gezocht naar een beschikbare bijpassende outfit. Als er geen wordt gevonden, valideert de SDK en geeft in plaats daarvan het eerste kledingstuk weer. Als de validatie mislukt, wordt er geen knop weergegeven en wordt de reden vastgelegd in de console.
Terugbelgesprekken
| Terugbellen | Laadvermogen |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", kleding, setIsLoading, closePopUp, onError |
Winkelwagenkleding bevat vereist id, partner_id, available En name, plus optioneel description en andere gegevens. Valideer voordat u deze aan uw winkelwagen toevoegt. Zie winkelwagen implementatie En knop-stijl voor voorbeelden.
Maakt geen deel uit van dit oppervlak
Er zijn geen gedocumenteerde per-view-switches, een standalone Compare Launcher of een standalone dimensioneringsmethode beschikbaar op de geretourneerde v3.0.0 SDK. features.loadingScreen is verwijderd. Leid geen opvraagbare methoden af uit overgebleven geëxporteerde typen of verouderde opmerkingen.