SPREEAI/開發者/文件

用
SPREEAI.

從整合方案選擇到經過測試的正式上線,這是一條切實可行的路徑。首先建立一個購物流程,使用已頒發的測試存取權限,並將憑證從瀏覽器程式碼中分離出來。

公共指南Web SDK v3.0.0更新於2026年10月

選擇集成路徑

小路最適合第一行動
Shopify 應用快速建立管理店面安裝該應用
Web SDK自訂或無頭網站請閱讀 SDK 指南
iOS/Android原生購物應用選擇一位當地嚮導
公共 API已批准的伺服器端工作流程開啟已核准的參考
亞馬遜合作夥伴網絡市場整合即將推出
憑證安全。 範例僅使用佔位符。 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,
  });
}

初始化一次,僅針對符合條件的產品進行渲染,並將已記錄的用戶端回呼連接到您現有的分析工具。確認目前介面。 官方 Web SDK API 參考

API 存取

僅對入職流程中已核准的伺服器端工作流程使用公開的 Swagger 參考文件。將金鑰保存在伺服器上,區分測試和生產環境的存取權限,並將憑證範圍限定在所需的最小環境中。

未經批准的公開參考中未列出的直接 REST 端點、webhook 或身份驗證行為應視為不可用,直到合作夥伴工程部門確認為止。

開啟已核准的公共 API 參考

服裝資產基線

  • JPEG 或 PNG 格式;最小尺寸為 2,000 × 2,000 像素,最好達到 4K 解析度。
  • 每張照片只展示一件衣服,居中擺放,邊緣乾淨俐落,光線均勻柔和。
  • 必須使用正面視圖;如果啟用背面視圖,建議使用背面視圖。
  • 檔案名稱和目錄記錄中包含穩定的 SKU、款式或服裝 ID。
  • 物品周圍不得有手、衣架、造型道具、水印或無關衣物遮擋。
  • 啟用該功能前,已檢查變體映射。

品質保證和發布

  • 在目前的行動和桌面瀏覽器上測試完整的客戶旅程。
  • 驗證產品和變體映射、服裝準備和購物車行為。
  • 檢查鍵盤存取權限、焦點順序、可存取名稱和備用行為。
  • 衡量啟用 SPREEAI 前後的產品頁面效能。
  • 練習載入中、空白、不可用、逾時和重試狀態。
  • 確認同意書措詞和已核准的客戶影像處理方式。
  • 生產前需獲得工程、商務、品質保證和品牌的批准。

故障排除

按鈕未顯示

確認 SDK 初始化、客戶端識別碼、主機元素 ID、產品資格、服裝準備狀態和變體映射。然後檢查瀏覽器控制台和網路錯誤,無需共用令牌。

出現錯誤的商品或型號

將店鋪產品和變體 ID 與傳送至 SPREEAI 的記錄進行比較。確認當購物者更改變體時,渲染的請求也會改變。

體驗緩慢或無法使用。

測試已知可用的產品,驗證運行環境,檢查被阻止的請求,並與乾淨的瀏覽器會話進行比較。記錄時間戳記和可重現的故障序列,以便技術支援。

獲取開發者支持

電子郵件 support@spreeai.com 需包含環境資訊、產品或服裝 ID、瀏覽器或設備、大致時間戳記、預期行為和重現步驟。請勿包含機密資訊或客戶圖像。

文件

選擇您的語言。