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 אינה אפשרות init ב-v3. השותף נפתר מהלקוח המאומת. לא מוחזרת שיטת רינדור גודל עצמאית.
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 הוסר. אל תסיק שיטות הניתנות להתקשרות משאריות מיוצאות או הערות מיושנות.