เอกสาร

SDK 2.0 · ข้อมูลอ้างอิง

การอ้างอิง API Web SDK

พื้นผิวการรวมสาธารณะที่ตรวจสอบกับแพ็คเกจ v3.0.0 npm

init(options)

ผลตอบแทน Promise<SpreeAISDK | null>. เมื่อสําเร็จ วัตถุก็จะเผยออกมา renderTryOnButton(options): Promise<void>. ตรวจสอบค่าว่างก่อนเรนเดอร์

ตัวเลือกประเภทค่าเริ่มต้นวัตถุประสงค์
clientIdstringจําเป็นตัวระบุไคลเอนต์เบราว์เซอร์ที่ออก
baseApiURLstringhttps://api.spreeai.comต้นกําเนิด API ที่ได้รับอนุมัติ เปลี่ยนสําหรับสภาพแวดล้อมที่ออกเท่านั้น
baseURLstringhttps://vton.spreeai.comได้รับการอนุมัติแหล่งกําเนิดห้องลองโฮสต์

partnerId is not an init option in v3. คู่ค้าได้รับการแก้ไขจากไคลเอนต์ที่ได้รับการรับรองความถูกต้อง No standalone sizing render method is returned.

renderTryOnButton(options)

ตัวเลือกประเภทค่าเริ่มต้น/ข้อกําหนดวัตถุประสงค์
elementIdstringจําเป็นID ขององค์ประกอบโฮสต์ที่มีอยู่
garmentsGarmentInput[]ทางเลือกที่จําเป็นการใส่เสื้อผ้าที่แนะนํา ใช้อาร์เรย์ที่ไม่ว่างเปล่า
garmentIdstringทางเลือกที่เลิกใช้แล้วการป้อนข้อมูลแบบการ์เม้นท์เดี่ยวแบบเดิม ชอบเสื้อผ้า
variantVariantOptionsเลิกใช้แล้วตัวกรองแบบเดิมที่มี garmentId; ต้องการตัวเลือกสินค้าต่อรายการ
classNamestringไม่จำเป็นคลาสปุ่มเพิ่มเติม
button{ text?: string }ไม่จำเป็นป้ายปุ่ม; ถูกแทนที่โดย features.tryOnButton.text
featuresTryOnFeaturesไม่จำเป็นการกําหนดค่าสไตล์ปุ่ม
eventsTryOnButtonEventsไม่จำเป็นตัวจัดการการคลิกและเพิ่มลงในรถเข็น
enableAddToCartbooleanfalseแสดงฟังก์ชันการเพิ่มลงตะกร้า ดําเนินการจัดการ
enableSizingRecommendationbooleanfalseขอคําแนะนําเกี่ยวกับขนาดในการลองสวม
showSizesbooleanfalseแสดง availableSizes ที่ให้มา
showPricesbooleanfalseแสดงราคาที่ให้มา
defaultUnits"metric" | "imperial"ไม่จำเป็นระบบหน่วยเริ่มต้นสําหรับการวัดโปรไฟล์

GarmentInput

สนามประเภทวัตถุประสงค์
garmentIdstringตัวระบุการ์เม้นท์ SPREEAI ที่จําเป็น
variantVariantOptionsตัวกรองสี ความพอดี เพศ หรือสไตล์ที่เป็นตัวเลือก
availableSizesstring[]ป้ายกํากับขนาดการแสดงผลปัจจุบันที่เป็นตัวเลือก
pricestringราคาที่แสดงเพิ่มเติม แสดงตามที่ให้มา

การตรวจสอบความถูกต้องและทางเลือก

สําหรับชุดแต่งเดี่ยว จะมีการตรวจสอบคุณสมบัติและรายละเอียดปลีกย่อยที่ปักหมุดไว้ก่อนที่จะเรนเดอร์ คําขอสวมเสื้อผ้าหลายชิ้นให้มองหาชุดที่เข้ากัน หากไม่พบ SDK จะตรวจสอบและแสดงผลการ์เม้นท์ชุดแรกแทน หากการตรวจสอบล้มเหลว จะไม่มีการแสดงปุ่มใดๆ และเหตุผลจะถูกบันทึกไว้ในคอนโซล

โทรกลับ

โทรกลับเพย์โหลด
onTryOnButtonClickname: "spreeai-try-on-button-clicked"
onAddToCartClickedname: "spreeai-add-to-cart-clicked", เสื้อผ้า, setIsLoading, closePopUp, onError

จําเป็นต้องมีเสื้อผ้าในรถเข็น id, partner_id, available และ nameบวกกับทางเลือก description และข้อมูลอื่นๆ ตรวจสอบก่อนที่จะแมปไปยังรถเข็นของคุณ ดูสิ การใช้งานรถเข็น และ สไตล์ปุ่ม สําหรับตัวอย่าง

ไม่ใช่ส่วนหนึ่งของพื้นผิวนี้

ไม่มีการเปิดเผยสวิตช์ต่อการดูที่จัดทําเป็นเอกสาร เปรียบเทียบตัวเรียกใช้งานแบบสแตนด์อโลนหรือวิธีการปรับขนาดแบบสแตนด์อโลนบน SDK เวอร์ชัน 3.0.0 ที่ส่งคืน features.loadingScreen ได้ถูกลบออกแล้ว อย่าอนุมานวิธีการที่เรียกได้จากประเภทที่ส่งออกที่เหลือหรือความคิดเห็นเก่า

แหล่งอ้างอิง

ค้นหาชื่อหน้าและเนื้อหา Escape ปิดการค้นหา

เลือกภาษาของคุณ