SPREEAI/pemaju/Dokumentasi

Bina dengan
SPREEAI.

Laluan praktikal daripada pilihan penyepaduan kepada pelancaran yang diuji. Mulakan dengan satu perjalanan perdagangan, gunakan akses ujian yang dikeluarkan dan simpan bukti kelayakan daripada kod penyemak imbas.

Pemandu awamSDK Web v3.0.0Dikemas kini Oktober 2026

Pilih laluan penyepaduan

LaluanTerbaik untukTindakan pertama
Aplikasi ShopifyPersediaan etalase terurus dengan pantasPasang apl
SDK WebWeb tersuai atau tanpa kepalaBaca panduan SDK
iOS / AndroidApl beli-belah asliPilih panduan asli
API AwamAliran kerja sebelah pelayan yang diluluskanBuka rujukan yang diluluskan
Rangkaian Rakan Kongsi AmazonPenyepaduan pasaranAkan datang
Keselamatan tauliah. Contoh menggunakan ruang letak sahaja. SPREEAI mengeluarkan akses yang diluluskan semasa onboarding. Jangan sekali-kali menerbitkan rahsia pelanggan, kunci API, token, nama hos peribadi atau data pelanggan.

Aplikasi Shopify

Gunakan aplikasi terurus apabila kedai berjalan pada Shopify dan tidak memerlukan backend tersuai. Aliran onboarding semasa menghubungkan kedai selepas perjanjian dan langganan; ia tidak memerlukan penyalinan kunci API ke dalam skrin persediaan.

  1. Pasang apl rasmi SPREEAI dan lengkapkan aliran persetujuan terurus.
  2. Segerakkan kumpulan katalog awal dan semak keadaan kesediaan produk.
  3. Sesuaikan peletakan dan penggayaan dalam tema pendua.
  4. Sahkan produk, varian, tingkah laku mudah alih dan tambah ke troli yang layak.
  5. Terbitkan hanya selepas jenama dan kelulusan QA.

Buka panduan onboarding rasmi Shopify

Permulaan pantas SDK Web

Gunakan @spreeai/web-sdk untuk penempatan, penggayaan, acara, saiz dan tingkah laku troli tersuai.

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

Mulakan sekali, buat hanya untuk produk yang layak dan sambungkan panggilan balik pelanggan yang didokumenkan ke analitis sedia ada anda. Sahkan antara muka semasa dalam rujukan API SDK Web rasmi

Akses API

Gunakan rujukan Swagger awam hanya untuk aliran kerja bahagian pelayan yang diluluskan semasa onboarding. Simpan rahsia pada pelayan anda, asingkan akses ujian dan pengeluaran serta kelayakan skop kepada persekitaran minimum yang diperlukan.

Titik tamat REST langsung, webhook atau gelagat pengesahan yang tidak terdapat dalam rujukan awam yang diluluskan harus dianggap sebagai tidak tersedia sehingga Kejuruteraan Rakan Kongsi mengesahkannya.

Buka rujukan API awam yang diluluskan

Garis asas aset pakaian

  • JPEG atau PNG; Minimum 2,000 × 2,000 px, dengan lebih kurang 4K pilihan.
  • Satu pakaian setiap imej, berpusat dengan tepi bersih dan neutral, pencahayaan sekata.
  • Pandangan hadapan diperlukan; pandangan belakang disyorkan apabila pengalaman itu didayakan.
  • SKU, gaya atau ID pakaian yang stabil disertakan dalam nama fail dan rekod katalog.
  • Tiada tangan, penyangkut, alat penggayaan, tera air atau pakaian yang tidak berkaitan yang menghalang item.
  • Pemetaan varian telah disemak sebelum mendayakan pengalaman.

QA dan pelancaran

  • Uji perjalanan pelanggan yang lengkap pada pelayar mudah alih dan desktop semasa.
  • Sahkan pemetaan produk dan varian, kesediaan pakaian dan tingkah laku troli.
  • Semak akses papan kekunci, susunan fokus, nama yang boleh diakses dan tingkah laku sandaran.
  • Ukur prestasi halaman produk sebelum dan selepas mendayakan SPREEAI.
  • Pemuatan latihan, kosong, tidak tersedia, tamat masa dan keadaan cuba semula.
  • Sahkan bahasa persetujuan dan pengendalian imej pelanggan yang diluluskan.
  • Dapatkan tandatangan kejuruteraan, perdagangan, QA dan jenama sebelum pengeluaran.

Penyelesaian masalah

Butang itu tidak muncul

Sahkan pemulaan SDK, pengecam pelanggan, ID elemen hos, kelayakan produk, kesediaan pakaian dan pemetaan varian. Kemudian semak ralat konsol penyemak imbas dan rangkaian tanpa berkongsi token.

Produk atau varian yang salah muncul

Bandingkan produk etalase dan ID varian dengan rekod yang dihantar ke SPREEAI. Sahkan bahawa permintaan yang diberikan berubah apabila pembeli menukar varian.

Pengalaman itu perlahan atau tidak tersedia

Uji produk sedia sedia yang diketahui, sahkan persekitaran aktif, periksa permintaan yang disekat dan bandingkan sesi pelayar yang bersih. Tangkap cap waktu dan jujukan yang boleh dihasilkan semula untuk sokongan.

Dapatkan sokongan pembangun

E-mel support@spreeai.com dengan persekitaran, ID produk atau pakaian, pelayar atau peranti, cap masa anggaran, tingkah laku yang dijangkakan dan langkah pembiakan. Jangan sertakan rahsia atau imejan pelanggan.

Dokumentasi

Pilih bahasa anda.