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 δεν είναι μια αρχική επιλογή στο 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 και άλλα στοιχεία. Επικυρώστε πριν από την αντιστοίχιση στο καλάθι σας. Βλ εφαρμογή καλαθιού και στυλ κουμπιών για παραδείγματα.
Δεν είναι μέρος αυτής της επιφάνειας
Δεν υπάρχουν τεκμηριωμένοι διακόπτες ανά προβολή, αυτόνομη εκκίνηση σύγκρισης ή αυτόνομη μέθοδος προσδιορισμού μεγέθους στο επιστρεφόμενο SDK έκδοσης 3.0.0. features.loadingScreen έχει αφαιρεθεί. Μην συνάγετε καλέσιμες μεθόδους από υπολειπόμενους εξαγόμενους τύπους ή μπαγιάτικα σχόλια.