Nyaraka

SDK 2.0 · REJEA

Marejeleo ya API ya Web SDK

Sehemu ya ujumuishaji wa umma imethibitishwa dhidi ya kifurushi cha v3.0.0 npm.

init(options)

marejesho Promise<SpreeAISDK | null>. Juu ya mafanikio, kitu kinafichua renderTryOnButton(options): Promise<void>. Angalia null kabla ya kutoa.

ChaguoAinaChaguo-msingiKusudi
clientIdstringInahitajikaKitambulisho cha mteja wa kivinjari kilichotolewa.
baseApiURLstringhttps://api.spreeai.comAsili ya API iliyoidhinishwa. Badilisha tu kwa mazingira yaliyotolewa.
baseURLstringhttps://vton.spreeai.comAsili ya chumba cha kufaa kilichoidhinishwa.

partnerId sio chaguo la init katika v3. Mshirika anatatuliwa kutoka kwa mteja aliyeidhinishwa. Hakuna njia ya kutoa ukubwa wa pekee inayorejeshwa.

renderTryOnButton(options)

ChaguoAinaChaguo-msingi / mahitajiKusudi
elementIdstringInahitajikaKitambulisho cha kipengee kilichopo cha seva pangishi.
garmentsGarmentInput[]Chaguo linalohitajikaIngizo la nguo lililopendekezwa. Tumia safu isiyo tupu.
garmentIdstringNjia mbadala iliyoacha kutumikaIngizo la urithi wa vazi moja. Pendelea mavazi.
variantVariantOptionsImeacha kutumikaKichujio cha urithi na garmentId; pendelea lahaja kwa kila kitu.
classNamestringHiariDarasa la kifungo cha ziada.
button{ text?: string }HiariLebo ya kifungo; imebatilishwa na features.tryOnButton.text.
featuresTryOnFeaturesHiariUsanidi wa mtindo wa vifungo.
eventsTryOnButtonEventsHiariBofya na vidhibiti vya kuongeza kwa mkokoteni.
enableAddToCartbooleanfalseOnyesha utendakazi wa kuongeza kwenye mkokoteni. Tekeleza kidhibiti.
enableSizingRecommendationbooleanfalseOmba mapendekezo ya ukubwa ndani ya jaribio.
showSizesbooleanfalseOnyesha hutolewa availableSizes.
showPricesbooleanfalseOnyesha bei iliyotolewa.
defaultUnits"metric" | "imperial"HiariMfumo wa kitengo cha kuanza kwa vipimo vya wasifu.

GarmentInput

ShambaAinaKusudi
garmentIdstringKitambulishi cha nguo cha SPREEAI kinachohitajika.
variantVariantOptionsRangi ya hiari, inafaa, jinsia au kichujio cha mtindo.
availableSizesstring[]Lebo za ukubwa wa onyesho za hiari.
pricestringBei ya hiari ya kuonyesha, iliyoonyeshwa kama ilivyotolewa.

Uthibitishaji na kurudi nyuma

Kwa vazi moja, ustahiki na lahaja yoyote iliyobandikwa huangaliwa kabla ya kutekelezwa. Maombi ya nguo nyingi hutafuta mavazi yanayolingana. Ikiwa hakuna iliyopatikana, SDK inathibitisha na kutoa vazi la kwanza badala yake. Ikiwa uthibitishaji utashindwa, hakuna kifungo kinachotolewa na sababu imeingia kwenye console.

Simu za nyuma

Piga simu tenaUpakiaji
onTryOnButtonClickname: "spreeai-try-on-button-clicked"
onAddToCartClickedname: "spreeai-add-to-cart-clicked", mavazi, setIsLoading, closePopUp, onError

Nguo za mkokoteni zina zinazohitajika id, partner_id, available na name, pamoja na chaguo description na data nyingine. Thibitisha kabla ya kuweka ramani kwenye rukwama yako. Tazama utekelezaji wa gari na mtindo wa kifungo kwa mifano.

Sio sehemu ya uso huu

Hakuna swichi za kila mwonekano uliorekodiwa, kizindua cha Linganisha kilichojitegemea au mbinu ya kusawazisha inayojitegemea hufichuliwa kwenye SDK ya v3.0.0 iliyorejeshwa. features.loadingScreen imeondolewa. Usichukulie mbinu zinazoweza kupigiwa simu kutoka kwa aina zilizosalia zilizosafirishwa au maoni yaliyochakaa.

Marejeleo ya chanzo

Tafuta vichwa vya kurasa na yaliyomo. Escape hufunga utafutaji.

Chagua lugha yako.