init(options)
عمليات الإرجاع Promise<SpreeAISDK | null>. عند النجاح، ينكشف الكائن renderTryOnButton(options): Promise<void>. تحقق من وجود قيمة فارغة قبل التقديم.
| الخيار | اكتب | تقصير | الغرض |
|---|---|---|---|
clientId | string | مطلوب | تم إصدار معرف عميل المتصفح. |
baseApiURL | string | https://api.spreeai.com | أصل API المعتمد. التغيير فقط للبيئة الصادرة. |
baseURL | string | https://vton.spreeai.com | أصل غرفة القياس المستضافة المعتمدة. |
partnerId ليس خيارًا أوليًا في الإصدار 3. يتم حل الشريك من العميل الذي تمت مصادقته. لا يتم إرجاع أي أسلوب عرض للتحجيم مستقل.
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 | سعر العرض الاختياري، كما هو موضح. |
التحقق من الصحة والاحتياطي
بالنسبة للملابس الواحدة، يتم التحقق من الأهلية وأي متغير مثبت قبل العرض. تبحث طلبات الملابس المتعددة عن ملابس مطابقة متاحة. إذا لم يتم العثور على أي شيء، فإن SDK يتحقق من صحة الثوب الأول ويعرضه بدلاً من ذلك. إذا فشل التحقق من الصحة، فلن يتم عرض أي زر وسيتم تسجيل السبب في وحدة التحكم.
عمليات الاسترجاعات
| رد الاتصال | الحمولة |
|---|---|
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 تمت إزالته. لا تستنتج الأساليب القابلة للاستدعاء من الأنواع المصدرة المتبقية أو التعليقات القديمة.