init(options)
pulangan Promise<SpreeAISDK | null>. Apabila berjaya, objek itu terdedah renderTryOnButton(options): Promise<void>. Semak nol sebelum rendering.
| Pilihan | taip | Lalai | Tujuan |
|---|---|---|---|
clientId | string | Diperlukan | Pengecam klien penyemak imbas yang dikeluarkan. |
baseApiURL | string | https://api.spreeai.com | Asal API yang diluluskan. Tukar hanya untuk persekitaran yang dikeluarkan. |
baseURL | string | https://vton.spreeai.com | Asal bilik kelengkapan dihoskan yang diluluskan. |
partnerId bukan pilihan init dalam v3. Rakan kongsi diselesaikan daripada pelanggan yang disahkan. Tiada kaedah pemaparan saiz kendiri dikembalikan.
renderTryOnButton(options)
| Pilihan | taip | Lalai / keperluan | Tujuan |
|---|---|---|---|
elementId | string | Diperlukan | ID elemen hos sedia ada. |
garments | GarmentInput[] | Pilihan yang diperlukan | Input pakaian yang disyorkan. Gunakan tatasusunan bukan kosong. |
garmentId | string | Alternatif yang tidak digunakan lagi | Input pakaian tunggal warisan. Lebih suka pakaian. |
variant | VariantOptions | Ditamatkan | Penapis lama dengan garmentId; lebih suka varian per item. |
className | string | Pilihan | Kelas butang tambahan. |
button | { text?: string } | Pilihan | Label butang; ditindih oleh features.tryOnButton.text. |
features | TryOnFeatures | Pilihan | Konfigurasi penggayaan butang. |
events | TryOnButtonEvents | Pilihan | Pengendali klik dan tambah pada troli. |
enableAddToCart | boolean | false | Paparkan fungsi tambah pada troli. Laksanakan pengendali. |
enableSizingRecommendation | boolean | false | Minta cadangan saiz dalam percubaan. |
showSizes | boolean | false | Tunjukkan availableSizes yang dibekalkan. |
showPrices | boolean | false | Tunjukkan harga yang dibekalkan. |
defaultUnits | "metric" | "imperial" | Pilihan | Memulakan sistem unit untuk ukuran profil. |
GarmentInput
| Padang | taip | Tujuan |
|---|---|---|
garmentId | string | Pengecam pakaian SPREEAI diperlukan. |
variant | VariantOptions | Penapis warna, kesesuaian, jantina atau gaya pilihan. |
availableSizes | string[] | Label saiz paparan semasa pilihan. |
price | string | Harga paparan pilihan, ditunjukkan sebagai dibekalkan. |
Pengesahan dan sandaran
Untuk satu pakaian, kelayakan dan sebarang varian yang disematkan disemak sebelum dipamerkan. Permintaan berbilang pakaian mencari pakaian padanan yang tersedia. Jika tiada yang ditemui, SDK mengesahkan dan menjadikan pakaian pertama sebaliknya. Jika pengesahan gagal, tiada butang diberikan dan sebabnya dilog masuk 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 troli mengandungi yang diperlukan id, partner_id, available dan name, ditambah pilihan description dan data lain. Sahkan sebelum memetakan ke troli anda. Lihat pelaksanaan troli dan penggayaan butang untuk contoh.
Bukan sebahagian daripada permukaan ini
Tiada suis setiap paparan yang didokumenkan, pelancar Bandingkan kendiri atau kaedah saiz kendiri terdedah pada SDK v3.0.0 yang dikembalikan. features.loadingScreen telah dikeluarkan. Jangan menyimpulkan kaedah boleh dipanggil daripada jenis yang dieksport yang sisa atau ulasan lapuk.