SPREEAI/นักพัฒนา/เอกสารประกอบ

สร้างด้วย
SPREEAI.

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

คู่มือสาธารณะเว็บ SDK เวอร์ชัน 3.0.0ปรับปรุงล่าสุด ตุลาคม 2569

เลือกเส้นทางการผสานรวม

เส้นทางเหมาะที่สุดสำหรับการดำเนินการครั้งแรก
แอป Shopifyการตั้งค่าหน้าร้านที่รวดเร็วและจัดการได้ง่ายติดตั้งแอป
เว็บ SDKเว็บแบบกำหนดเองหรือเว็บไร้ส่วนหัวอ่านคู่มือ SDK
iOS / Androidแอปช้อปปิ้งแบบเนทีฟเลือกไกด์ท้องถิ่น
API สาธารณะเวิร์กโฟลว์ฝั่งเซิร์ฟเวอร์ที่ได้รับการอนุมัติเปิดเอกสารอ้างอิงที่ได้รับการอนุมัติ
เครือข่ายพันธมิตรของ Amazonการผสานรวมตลาดเร็วๆ นี้
ความปลอดภัยของข้อมูลประจำตัว ตัวอย่างใช้เพียงตัวยึดตำแหน่งเท่านั้น SPREEAI จะออกสิทธิ์การเข้าถึงที่ได้รับอนุมัติระหว่างการเริ่มต้นใช้งาน ห้ามเผยแพร่รหัสลับไคลเอ็นต์ คีย์ API โทเค็น ชื่อโฮสต์ส่วนตัว หรือข้อมูลลูกค้าโดยเด็ดขาด

แอป Shopify

ใช้แอปที่จัดการโดยระบบเมื่อร้านค้าทำงานบน Shopify และไม่ต้องการแบ็กเอนด์แบบกำหนดเอง ขั้นตอนการเริ่มต้นใช้งานในปัจจุบันจะเชื่อมต่อร้านค้าหลังจากข้อตกลงและการสมัครสมาชิกเสร็จสิ้นแล้ว โดยไม่จำเป็นต้องคัดลอกคีย์ API ลงในหน้าจอการตั้งค่า

  1. ติดตั้งแอปพลิเคชัน SPREEAI อย่างเป็นทางการ และดำเนินการตามขั้นตอนการให้ความยินยอมที่ได้รับการจัดการให้เสร็จสมบูรณ์
  2. ซิงค์กลุ่มแคตตาล็อกเริ่มต้นและตรวจสอบสถานะความพร้อมของผลิตภัณฑ์
  3. ปรับแต่งตำแหน่งและการจัดสไตล์ในธีมที่คัดลอกมา
  4. ตรวจสอบความถูกต้องของผลิตภัณฑ์ ตัวเลือกสินค้า พฤติกรรมการใช้งานบนมือถือ และการเพิ่มลงในตะกร้าสินค้า
  5. เผยแพร่ได้หลังจากได้รับการอนุมัติจากแบรนด์และฝ่ายควบคุมคุณภาพแล้วเท่านั้น

เปิดคู่มือการเริ่มต้นใช้งานอย่างเป็นทางการของ Shopify

คู่มือเริ่มต้นใช้งาน Web SDK อย่างรวดเร็ว

ใช้ @spreeai/web-sdk สำหรับการจัดวาง การจัดสไตล์ เหตุการณ์ ขนาด และพฤติกรรมของตะกร้าสินค้าแบบกำหนดเอง

npm install @spreeai/web-sdk@3.0.0

import { init } from "@spreeai/web-sdk";
import "@spreeai/web-sdk/dist/web-sdk.css";

// Add <div id="spreeai-try-on"></div> to the product page first.
const sdk = await init({ clientId: "your-client-id" });

if (sdk) {
  await sdk.renderTryOnButton({
    elementId: "spreeai-try-on",
    garments: [{ garmentId: "your-garment-id" }],
    enableAddToCart: true,
  });
}

เริ่มต้นเพียงครั้งเดียว แสดงผลเฉพาะสำหรับผลิตภัณฑ์ที่เข้าเกณฑ์ และเชื่อมต่อการเรียกกลับของลูกค้าที่ได้รับการบันทึกไว้กับระบบวิเคราะห์ที่มีอยู่ของคุณ ยืนยันอินเทอร์เฟซปัจจุบันใน เอกสารอ้างอิง API อย่างเป็นทางการของ Web SDK

การเข้าถึง API

ใช้เอกสารอ้างอิง Swagger สาธารณะเฉพาะสำหรับเวิร์กโฟลว์ฝั่งเซิร์ฟเวอร์ที่ได้รับการอนุมัติระหว่างการเริ่มต้นใช้งานเท่านั้น เก็บความลับไว้ในเซิร์ฟเวอร์ของคุณ แยกการเข้าถึงสำหรับการทดสอบและการใช้งานจริง และจำกัดสิทธิ์การเข้าถึงให้เหลือเพียงสภาพแวดล้อมที่จำเป็นขั้นต่ำเท่านั้น

เอนด์พอยต์ REST โดยตรง เว็บฮุค หรือพฤติกรรมการตรวจสอบสิทธิ์ที่ไม่ปรากฏในเอกสารอ้างอิงสาธารณะที่ได้รับการอนุมัติ ควรได้รับการพิจารณาว่าไม่สามารถใช้งานได้จนกว่าทีมวิศวกรรมพันธมิตรจะยืนยัน

เปิดเอกสารอ้างอิง API สาธารณะที่ได้รับการอนุมัติ

ฐานสินทรัพย์เสื้อผ้า

  • ไฟล์ JPEG หรือ PNG; ขนาดขั้นต่ำ 2,000 × 2,000 พิกเซล โดยควรมีความละเอียดประมาณ 4K
  • ภาพละหนึ่งชิ้น จัดวางให้อยู่ตรงกลาง มีขอบคมชัด และแสงสว่างสม่ำเสมอเป็นกลาง
  • จำเป็นต้องดูจากด้านหน้า แนะนำให้ดูจากด้านหลังเมื่อเปิดใช้งานโหมดนั้น
  • รหัสสินค้า (SKU), สไตล์ หรือรหัสเสื้อผ้า ต้องระบุอยู่ในชื่อไฟล์และข้อมูลในแคตตาล็อกด้วย
  • ห้ามมีมือ ไม้แขวนเสื้อ อุปกรณ์ประกอบฉาก ลายน้ำ หรือเสื้อผ้าอื่นๆ ที่ไม่เกี่ยวข้องมาบังสินค้า
  • ตรวจสอบการจับคู่รูปแบบก่อนเปิดใช้งานประสบการณ์นี้

การทดสอบคุณภาพและการเปิดตัว

  • ทดสอบประสบการณ์การใช้งานของลูกค้าอย่างครบถ้วนบนเบราว์เซอร์มือถือและเดสก์ท็อปในปัจจุบัน
  • ตรวจสอบการจับคู่ผลิตภัณฑ์และตัวเลือกต่างๆ ความพร้อมของเสื้อผ้า และพฤติกรรมของตะกร้าสินค้า
  • ตรวจสอบการเข้าถึงแป้นพิมพ์ ลำดับการโฟกัส ชื่อที่เข้าถึงได้ และพฤติกรรมสำรอง
  • วัดประสิทธิภาพของหน้าผลิตภัณฑ์ก่อนและหลังเปิดใช้งาน SPREEAI
  • สถานะการโหลดแบบฝึกหัด, ว่างเปล่า, ไม่พร้อมใช้งาน, หมดเวลา และการลองใหม่
  • ตรวจสอบข้อความแสดงความยินยอมและวิธีการจัดการภาพลูกค้าที่ได้รับอนุมัติแล้ว
  • ขออนุมัติจากฝ่ายวิศวกรรม ฝ่ายการค้า ฝ่ายควบคุมคุณภาพ และฝ่ายแบรนด์ก่อนเริ่มการผลิต

การแก้ไขปัญหา

ปุ่มไม่ปรากฏขึ้น

ตรวจสอบการเริ่มต้นใช้งาน SDK, ตัวระบุไคลเอ็นต์, รหัสองค์ประกอบโฮสต์, คุณสมบัติของผลิตภัณฑ์, ความพร้อมของเสื้อผ้า และการแมปตัวแปร จากนั้นตรวจสอบคอนโซลของเบราว์เซอร์และข้อผิดพลาดเครือข่ายโดยไม่ต้องแชร์โทเค็น

ปรากฏสินค้าหรือรุ่นที่ไม่ถูกต้อง

เปรียบเทียบรหัสสินค้าและรหัสตัวเลือกสินค้าของหน้าร้านค้ากับข้อมูลที่ส่งไปยัง SPREEAI ตรวจสอบว่าคำขอที่แสดงผลเปลี่ยนแปลงไปเมื่อผู้ซื้อเปลี่ยนตัวเลือกสินค้า

ประสบการณ์การใช้งานช้าหรือไม่สามารถใช้งานได้

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

รับการสนับสนุนจากนักพัฒนา

อีเมล support@spreeai.com โดยระบุสภาพแวดล้อม รหัสสินค้าหรือเสื้อผ้า เบราว์เซอร์หรืออุปกรณ์ เวลาโดยประมาณ พฤติกรรมที่คาดหวัง และขั้นตอนการจำลองปัญหา ห้ามระบุข้อมูลที่เป็นความลับหรือภาพของลูกค้า

เอกสารประกอบ

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