init(options)
trả lại Promise<SpreeAISDK | null>. Khi thành công, đối tượng lộ diện renderTryOnButton(options): Promise<void>. Kiểm tra null trước khi kết xuất.
| Tùy chọn | Loại | Mặc định | Mục đích |
|---|---|---|---|
clientId | string | Bắt buộc | Số nhận dạng ứng dụng khách của trình duyệt đã được cấp. |
baseApiURL | string | https://api.spreeai.com | Nguồn gốc API được phê duyệt. Chỉ thay đổi đối với môi trường đã ban hành. |
baseURL | string | https://vton.spreeai.com | Nguồn gốc phòng thử đồ được lưu trữ đã được phê duyệt. |
partnerId không phải là một tùy chọn init trong v3. Đối tác được giải quyết từ khách hàng được xác thực. Không có phương thức kết xuất kích thước độc lập nào được trả về.
renderTryOnButton(options)
| Tùy chọn | Loại | Mặc định/yêu cầu | Mục đích |
|---|---|---|---|
elementId | string | Bắt buộc | ID của phần tử máy chủ hiện có. |
garments | GarmentInput[] | Lựa chọn bắt buộc | Đầu vào may mặc được đề xuất. Sử dụng một mảng không trống. |
garmentId | string | Giải pháp thay thế không được dùng nữa | Đầu vào đơn hàng kế thừa. Ưu tiên hàng may mặc. |
variant | VariantOptions | Không được dùng nữa | Bộ lọc kế thừa với garmentId; thích biến thể cho mỗi mục. |
className | string | Không bắt buộc | Lớp nút bổ sung. |
button | { text?: string } | Không bắt buộc | Nhãn nút; bị ghi đè bởi features.tryOnButton.text. |
features | TryOnFeatures | Không bắt buộc | Cấu hình kiểu dáng nút. |
events | TryOnButtonEvents | Không bắt buộc | Trình xử lý nhấp chuột và thêm vào giỏ hàng. |
enableAddToCart | boolean | false | Hiển thị chức năng thêm vào giỏ hàng. Thực hiện trình xử lý. |
enableSizingRecommendation | boolean | false | Yêu cầu đề xuất kích thước khi thử. |
showSizes | boolean | false | Hiển thị availableSizes được cung cấp. |
showPrices | boolean | false | Hiển thị giá cung cấp. |
defaultUnits | "metric" | "imperial" | Không bắt buộc | Hệ thống đơn vị khởi đầu để đo biên dạng. |
GarmentInput
| trường | Loại | Mục đích |
|---|---|---|
garmentId | string | Bắt buộc phải có số nhận dạng quần áo SPREEAI. |
variant | VariantOptions | Bộ lọc màu sắc, độ vừa vặn, giới tính hoặc kiểu dáng tùy chọn. |
availableSizes | string[] | Nhãn kích thước hiển thị hiện tại tùy chọn. |
price | string | Giá hiển thị tùy chọn, hiển thị như được cung cấp. |
Xác thực và dự phòng
Đối với một sản phẩm may mặc, tính đủ điều kiện và mọi biến thể được ghim đều được kiểm tra trước khi kết xuất. Các yêu cầu về nhiều loại quần áo sẽ tìm kiếm một bộ trang phục phù hợp có sẵn. Nếu không tìm thấy, SDK sẽ xác thực và hiển thị trang phục đầu tiên. Nếu xác thực không thành công, không có nút nào được hiển thị và lý do được ghi vào bảng điều khiển.
Cuộc gọi lại
| Gọi lại | Tải trọng |
|---|---|
onTryOnButtonClick | name: "spreeai-try-on-button-clicked" |
onAddToCartClicked | name: "spreeai-add-to-cart-clicked", hàng may mặc, setIsLoading, closePopUp, onError |
Giỏ hàng may mặc chứa yêu cầu id, partner_id, available Và name, cộng thêm tùy chọn description và các dữ liệu khác. Xác thực trước khi ánh xạ tới giỏ hàng của bạn. Xem thực hiện giỏ hàng Và kiểu dáng nút để biết ví dụ.
Không phải là một phần của bề mặt này
Không có tài liệu chuyển đổi cho mỗi chế độ xem, trình khởi chạy So sánh độc lập hoặc phương pháp định cỡ độc lập nào được hiển thị trên SDK v3.0.0 được trả về. features.loadingScreen đã được gỡ bỏ. Không suy ra các phương thức có thể gọi được từ các loại đã xuất còn sót lại hoặc các nhận xét cũ.