文档

SDK 2.0 · 从这里开始

Web SDK 快速入门

为一款符合条件的产品呈现试用按钮,然后根据工作基线进行构建。

开始之前

  • A clientId 由 SPREEAI 为您批准的环境颁发。
  • 已完成摄取的服装属于您的帐户并可供试穿。
  • 您可以编辑的产品页面和具有唯一 HTML ID 的容器。

1. 安装

终端
npm install @spreeai/web-sdk@3.0.0

样式表是包的一部分,必须包含在您的包中。

2.添加容器

HTML
<div id="spreeai-try-on"></div>

3. 初始化和渲染

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

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

if (sdk) {
  await sdk.renderTryOnButton({
    elementId: "spreeai-try-on",
    garments: [{ garmentId: "YOUR_READY_GARMENT_ID" }],
  });
} else {
  // Keep the normal product and purchase journey available.
  console.warn("SPREEAI could not initialize.");
}

init() 可以返回 null。在渲染之前检查结果,并在每个页面而不是每个按钮初始化一次。

4. 检查结果

  1. 加载产品页面。有效、可用的服装会呈现一个试穿按钮。
  2. 打开试衣间,确认想要的服装和颜色。
  3. 关闭并重新打开它。检查手机和桌面上的体验。
  4. 在您的测试环境中尝试不可用的服装。确认您的正常产品和结账路径仍然可用。

下一步去哪里

来源参考

搜索页面标题和内容。 Escape 关闭搜索。

选择您的语言。