SPREEAI/Pengembang/Dokumentasi

Bangun dengan
SPREEAI.

Panduan praktis dari pilihan integrasi hingga peluncuran yang teruji. Mulailah dengan satu alur perdagangan, gunakan akses uji yang diberikan, dan jauhkan kredensial dari kode browser.

Panduan publikWeb SDK v3.0.0Diperbarui Oktober 2026

Pilih jalur integrasi

JalurTerbaik untukTindakan pertama
Aplikasi ShopifyPengaturan toko online yang cepat dan terkelola dengan baik.Instal aplikasinya
SDK WebWeb kustom atau tanpa antarmuka pengguna (headless web)Baca panduan SDK.
iOS / AndroidAplikasi belanja asliPilih pemandu lokal.
API PublikAlur kerja sisi server yang disetujuiBuka referensi yang disetujui
Jaringan Mitra AmazonIntegrasi marketplaceSegera hadir
Keamanan kredensial. Contoh hanya menggunakan placeholder. SPREEAI memberikan akses yang disetujui selama proses onboarding. Jangan pernah mempublikasikan rahasia klien, kunci API, token, nama host pribadi, atau data pelanggan.

Aplikasi Shopify

Gunakan aplikasi terkelola saat toko berjalan di Shopify dan tidak memerlukan backend khusus. Alur onboarding saat ini menghubungkan toko setelah perjanjian dan berlangganan; alur ini tidak memerlukan penyalinan kunci API ke layar pengaturan.

  1. Instal aplikasi resmi SPREEAI dan selesaikan alur persetujuan terkelola.
  2. Sinkronkan grup katalog awal dan tinjau status kesiapan produk.
  3. Sesuaikan penempatan dan gaya pada tema yang diduplikasi.
  4. Validasi produk, varian, perilaku seluler, dan penambahan ke keranjang yang memenuhi syarat.
  5. Publikasikan hanya setelah mendapat persetujuan dari merek dan tim QA.

Buka panduan orientasi resmi Shopify

Panduan singkat Web SDK

Menggunakan @spreeai/web-sdk untuk penempatan khusus, penataan gaya, acara, ukuran, dan perilaku keranjang belanja.

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,
  });
}

Lakukan inisialisasi sekali, tampilkan hanya untuk produk yang memenuhi syarat, dan hubungkan callback klien yang terdokumentasi ke analitik Anda yang sudah ada. Konfirmasikan antarmuka saat ini di Referensi API Web SDK resmi

Akses API

Gunakan referensi Swagger publik hanya untuk alur kerja sisi server yang disetujui selama proses orientasi. Simpan rahasia di server Anda, pisahkan akses pengujian dan produksi, dan batasi kredensial ke lingkungan minimum yang dibutuhkan.

Endpoint REST langsung, webhook, atau perilaku autentikasi yang tidak terdapat dalam referensi publik yang disetujui harus dianggap tidak tersedia sampai Partner Engineering mengkonfirmasinya.

Buka referensi API publik yang telah disetujui.

Basis aset garmen

  • JPEG atau PNG; minimal 2.000 × 2.000 piksel, dengan resolusi sekitar 4K lebih disukai.
  • Satu pakaian per gambar, dipusatkan dengan tepi yang rapi dan pencahayaan netral serta merata.
  • Tampilan depan wajib; tampilan belakang disarankan jika pengalaman tersebut diaktifkan.
  • SKU, gaya, atau ID pakaian yang stabil disertakan dalam nama file dan catatan katalog.
  • Tidak ada tangan, gantungan baju, alat bantu penataan gaya, tanda air, atau pakaian lain yang menghalangi item tersebut.
  • Pemetaan varian diperiksa sebelum mengaktifkan pengalaman tersebut.

QA dan peluncuran

  • Uji seluruh perjalanan pelanggan pada browser seluler dan desktop terkini.
  • Verifikasi pemetaan produk dan varian, kesiapan pakaian, dan perilaku keranjang belanja.
  • Periksa akses keyboard, urutan fokus, nama yang dapat diakses, dan perilaku fallback.
  • Ukur kinerja halaman produk sebelum dan sesudah mengaktifkan SPREEAI.
  • Status pemuatan latihan, kosong, tidak tersedia, waktu habis, dan coba lagi.
  • Konfirmasikan bahasa persetujuan dan penanganan gambar pelanggan yang telah disetujui.
  • Dapatkan persetujuan dari bagian teknik, perdagangan, QA, dan merek sebelum produksi.

Penyelesaian Masalah

Tombolnya tidak muncul

Konfirmasikan inisialisasi SDK, pengenal klien, ID elemen host, kelayakan produk, kesiapan garmen, dan pemetaan varian. Kemudian periksa konsol browser dan kesalahan jaringan tanpa berbagi token.

Produk atau varian yang salah muncul.

Bandingkan ID produk dan varian di toko online dengan data yang dikirim ke SPREEAI. Konfirmasikan bahwa permintaan yang ditampilkan berubah ketika pembeli mengubah varian.

Pengalaman tersebut lambat atau tidak tersedia.

Uji produk yang sudah dipastikan siap pakai, verifikasi lingkungan aktif, periksa permintaan yang diblokir, dan bandingkan dengan sesi browser yang bersih. Catat stempel waktu dan urutan yang dapat direproduksi untuk keperluan dukungan.

Dapatkan dukungan pengembang

E-mail support@spreeai.com Sertakan informasi lingkungan, ID produk atau pakaian, peramban atau perangkat, perkiraan waktu, perilaku yang diharapkan, dan langkah-langkah reproduksi. Jangan sertakan informasi rahasia atau gambar pelanggan.

Dokumentasi

Pilih bahasa Anda.