init(options)
awọn ipadabọ Promise<SpreeAISDK | null>. Lori aṣeyọri, ohun naa ṣafihan renderTryOnButton(options): Promise<void>. Ṣayẹwo fun asan ṣaaju ṣiṣe.
| Aṣayan | Iru | Aiyipada | Idi |
|---|---|---|---|
clientId | string | Ti beere fun | Idamo olubara ẹrọ aṣawakiri ti a pese. |
baseApiURL | string | https://api.spreeai.com | Ipilẹṣẹ API ti a fọwọsi. Yi pada nikan fun ohun ti oniṣowo ayika. |
baseURL | string | https://vton.spreeai.com | Ipilẹṣẹ yara ibaramu ti gbalejo. |
partnerId kii ṣe aṣayan init ni v3. Alabaṣepọ jẹ ipinnu lati ọdọ alabara ti o jẹri. Ko si ọna ti o ṣe iwọn adaduro ti a da pada.
renderTryOnButton(options)
| Aṣayan | Iru | Aiyipada / ibeere | Idi |
|---|---|---|---|
elementId | string | Ti beere fun | ID ti awọn ti wa tẹlẹ ogun ano. |
garments | GarmentInput[] | Aṣayan ti a beere | Iṣeduro aṣọ ti a ṣe iṣeduro. Lo orun ti ko ṣofo. |
garmentId | string | Yiyan ti a ti parẹ | Legacy nikan-aṣọ igbewọle. Ṣe ayanfẹ awọn aṣọ. |
variant | VariantOptions | Idinku | Ajọ àlẹmọ pẹlu garmentId; fẹ fun-ohun kan iyatọ. |
className | string | Àṣàyàn | Afikun bọtini kilasi. |
button | { text?: string } | Àṣàyàn | Bọtini aami; danu nipa features.tryOnButton.text. |
features | TryOnFeatures | Àṣàyàn | Bọtini iselona iṣeto ni. |
events | TryOnButtonEvents | Àṣàyàn | Tẹ ki o si fi-si-fun rira handlers. |
enableAddToCart | boolean | false | Ṣe afihan iṣẹ ṣiṣe afikun-si-ẹru. Mu olutọju naa ṣiṣẹ. |
enableSizingRecommendation | boolean | false | Beere awọn iṣeduro iwọn inu igbiyanju-lori. |
showSizes | boolean | false | Ṣe afihan availableSizes ti a pese. |
showPrices | boolean | false | Ṣe afihan idiyele ti a pese. |
defaultUnits | "metric" | "imperial" | Àṣàyàn | Bibẹrẹ eto ẹyọkan fun awọn wiwọn profaili. |
GarmentInput
| Aaye | Iru | Idi |
|---|---|---|
garmentId | string | Ti beere fun idanimọ aṣọ SPREEAI. |
variant | VariantOptions | Awọ iyan, ibamu, akọ-abo tabi àlẹmọ ara. |
availableSizes | string[] | Awọn aami iwọn ifihan lọwọlọwọ iyan. |
price | string | Iye owo ifihan iyan, han bi a ti pese. |
Afọwọsi ati fallback
Fun aṣọ ẹyọ kan, yiyẹ ati eyikeyi iyatọ pinni jẹ ayẹwo ṣaaju ṣiṣe. Awọn ibeere aṣọ-pupọ n wa aṣọ ti o baamu ti o wa. Ti ko ba si ọkan ti a rii, SDK fọwọsi ati pese aṣọ akọkọ dipo. Ti ijẹrisi ba kuna, ko si bọtini ti a ṣe ati idi rẹ ti wọle si console.
Ipepada
| Ipepada | Isanwo |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", aṣọ, setIsLoading, closePopUp, onError |
Awọn aṣọ fun rira ni ti a beere ninu id, partner_id, available àti name, plus iyan description ati awọn miiran data. Fifọwọsi ṣaaju ṣiṣe aworan agbaye si rira rẹ. Wo rira imuse àti bọtini iselona fun apẹẹrẹ.
Ko ara ti yi dada
Ko si awọn iyipada iwe-iwoye kan ti o ni akọsilẹ, imurasilẹ Afiwe ifilọlẹ tabi ọna iwọn adaduro ti o han lori v3.0.0 SDK ti o pada. features.loadingScreen ti yọ kuro. Ma ṣe ni oye awọn ọna ti a le pe lati awọn iru ti a fi jade si okeere tabi awọn asọye ti ko duro.