init(options)
रिटर्न Promise<SpreeAISDK | null>. सफलता मिलने पर वस्तु उजागर हो जाती है renderTryOnButton(options): Promise<void>. रेंडर करने से पहले शून्य की जाँच करें।
| विकल्प | प्रकार | गलती करना | प्रयोजन |
|---|---|---|---|
clientId | string | आवश्यक | ब्राउज़र क्लाइंट पहचानकर्ता जारी किया गया। |
baseApiURL | string | https://api.spreeai.com | स्वीकृत एपीआई मूल. केवल जारी परिवेश के लिए परिवर्तन करें. |
baseURL | string | https://vton.spreeai.com | स्वीकृत होस्टेड फिटिंग-रूम मूल। |
partnerId v3 में init विकल्प नहीं है. पार्टनर का समाधान प्रमाणित क्लाइंट से किया जाता है। कोई स्टैंडअलोन साइज़िंग रेंडर विधि वापस नहीं की गई है।
renderTryOnButton(options)
| विकल्प | प्रकार | डिफ़ॉल्ट/आवश्यकता | प्रयोजन |
|---|---|---|---|
elementId | string | आवश्यक | मौजूदा होस्ट तत्व की आईडी. |
garments | GarmentInput[] | आवश्यक विकल्प | अनुशंसित परिधान इनपुट. एक गैर-रिक्त सरणी का उपयोग करें. |
garmentId | string | अस्वीकृत विकल्प | लीगेसी सिंगल-गारमेंट इनपुट। वस्त्रों को प्राथमिकता दें. |
variant | VariantOptions | बहिष्कृत | garmentId के साथ लीगेसी फ़िल्टर; प्रति-आइटम संस्करण को प्राथमिकता दें। |
className | string | वैकल्पिक | अतिरिक्त बटन वर्ग. |
button | { text?: string } | वैकल्पिक | बटन लेबल; features.tryOnButton.text द्वारा ओवरराइड किया गया। |
features | TryOnFeatures | वैकल्पिक | बटन स्टाइलिंग कॉन्फ़िगरेशन. |
events | TryOnButtonEvents | वैकल्पिक | क्लिक करें और कार्ट में हैंडलर जोड़ें। |
enableAddToCart | boolean | false | ऐड-टू-कार्ट कार्यक्षमता प्रदर्शित करें। हैंडलर लागू करें. |
enableSizingRecommendation | boolean | false | ट्राई-ऑन के अंदर आकार संबंधी अनुशंसाओं का अनुरोध करें। |
showSizes | boolean | false | आपूर्ति की गई availableSizes दिखाएं। |
showPrices | boolean | false | आपूर्ति की गई कीमत दिखाएँ. |
defaultUnits | "metric" | "imperial" | वैकल्पिक | प्रोफ़ाइल माप के लिए प्रारंभिक इकाई प्रणाली। |
GarmentInput
| मैदान | प्रकार | प्रयोजन |
|---|---|---|
garmentId | string | आवश्यक SPREEAI परिधान पहचानकर्ता। |
variant | VariantOptions | वैकल्पिक रंग, फिट, लिंग या शैली फ़िल्टर। |
availableSizes | string[] | वैकल्पिक वर्तमान प्रदर्शन आकार लेबल। |
price | string | वैकल्पिक प्रदर्शन मूल्य, आपूर्ति के अनुसार दिखाया गया है। |
सत्यापन और फ़ॉलबैक
किसी एकल परिधान के लिए, प्रस्तुत करने से पहले पात्रता और किसी भी पिन किए गए संस्करण की जाँच की जाती है। बहु-परिधान अनुरोध एक उपलब्ध मिलान पोशाक की तलाश करते हैं। यदि कोई नहीं मिलता है, तो एसडीके सत्यापित करता है और इसके बजाय पहला परिधान प्रस्तुत करता है। यदि सत्यापन विफल हो जाता है, तो कोई बटन प्रस्तुत नहीं किया जाता है और कारण कंसोल पर लॉग किया जाता है।
कॉलबैक
| कॉलबैक | पेलोड |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", वस्त्र, setIsLoading, closePopUp, onError |
कार्ट में आवश्यक वस्त्र शामिल हैं id, partner_id, available और name, प्लस वैकल्पिक description और अन्य डेटा. अपने कार्ट पर मैप करने से पहले सत्यापित करें. देखिये कार्ट कार्यान्वयन और बटन स्टाइलिंग उदाहरण के लिए.
इस सतह का हिस्सा नहीं
लौटाए गए v3.0.0 SDK पर कोई प्रलेखित प्रति-दृश्य स्विच, स्टैंडअलोन तुलना लॉन्चर या स्टैंडअलोन आकार पद्धति प्रदर्शित नहीं की गई है। features.loadingScreen हटा दिया गया है. बचे हुए निर्यातित प्रकारों या पुरानी टिप्पणियों से कॉल करने योग्य तरीकों का अनुमान न लगाएं।