init(options)
pengembalian Promise<SpreeAISDK | null>. Jika berhasil, objek akan terekspos renderTryOnButton(options): Promise<void>. Periksa null sebelum merender.
| Pilihan | Ketik | Bawaan | Tujuan |
|---|---|---|---|
clientId | string | Diperlukan | Pengenal klien browser yang dikeluarkan. |
baseApiURL | string | https://api.spreeai.com | Asal API yang disetujui. Ubah hanya untuk lingkungan yang dikeluarkan. |
baseURL | string | https://vton.spreeai.com | Disetujui asal kamar pas yang dihosting. |
partnerId bukan opsi init di v3. Mitra diselesaikan dari klien yang diautentikasi. Tidak ada metode render ukuran mandiri yang dikembalikan.
renderTryOnButton(options)
| Pilihan | Ketik | Default/persyaratan | Tujuan |
|---|---|---|---|
elementId | string | Diperlukan | ID elemen host yang ada. |
garments | GarmentInput[] | Pilihan yang diperlukan | Masukan pakaian yang direkomendasikan. Gunakan array yang tidak kosong. |
garmentId | string | Alternatif yang tidak digunakan lagi | Masukan pakaian tunggal yang lama. Lebih suka pakaian. |
variant | VariantOptions | Tidak digunakan lagi | Filter lama dengan garmentId; lebih memilih varian per item. |
className | string | Opsional | Kelas tombol tambahan. |
button | { text?: string } | Opsional | Label tombol; ditimpa oleh features.tryOnButton.text. |
features | TryOnFeatures | Opsional | Konfigurasi gaya tombol. |
events | TryOnButtonEvents | Opsional | Penangan klik dan tambahkan ke troli. |
enableAddToCart | boolean | false | Tampilkan fungsionalitas tambahkan ke troli. Menerapkan pawang. |
enableSizingRecommendation | boolean | false | Minta rekomendasi ukuran dalam uji coba. |
showSizes | boolean | false | Tampilkan availableSizes yang disertakan. |
showPrices | boolean | false | Tampilkan harga yang disediakan. |
defaultUnits | "metric" | "imperial" | Opsional | Sistem unit awal untuk pengukuran profil. |
GarmentInput
| Bidang | Ketik | Tujuan |
|---|---|---|
garmentId | string | Pengenal pakaian SPREEAI yang diperlukan. |
variant | VariantOptions | Filter warna, kecocokan, jenis kelamin, atau gaya opsional. |
availableSizes | string[] | Label ukuran tampilan opsional saat ini. |
price | string | Harga tampilan opsional, ditampilkan seperti yang disediakan. |
Validasi dan penggantian
Untuk satu pakaian, kelayakan dan varian apa pun yang dipasangi pin diperiksa sebelum dirender. Permintaan multi-garmen mencari pakaian serasi yang tersedia. Jika tidak ada yang ditemukan, SDK akan memvalidasi dan merender pakaian pertama. Jika validasi gagal, tidak ada tombol yang ditampilkan dan alasannya dicatat ke konsol.
Panggilan balik
| Panggilan balik | Muatan |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", pakaian, setIsLoading, closePopUp, onError |
Pakaian keranjang berisi yang diperlukan id, partner_id, available Dan name, ditambah opsional description dan data lainnya. Validasi sebelum memetakan ke keranjang Anda. Lihat implementasi gerobak Dan penataan tombol untuk contoh.
Bukan bagian dari permukaan ini
Tidak ada peralihan per tampilan yang terdokumentasi, peluncur Bandingkan mandiri, atau metode pengukuran mandiri yang diekspos pada SDK v3.0.0 yang dikembalikan. features.loadingScreen telah dihapus. Jangan menyimpulkan metode yang dapat dipanggil dari jenis sisa yang diekspor atau komentar basi.