API - Viewer、Configurator和Customizer

获取产品并将其与工具关联，为嵌入Viewer、Configurator和Customizer创建安全会话。

端点概览

方法	端点	说明	访问权限
`GET`	`/public-api/v1/products`	返回店铺产品／设计，包含嵌入可用性和媒体 URL。	`products:read`
`GET`	`/public-api/v1/products/:id`	返回一个店铺产品／设计。	`products:read`
`POST`	`/public-api/v1/embed/session`	为嵌入式工具（包括模型生成器）签发短期有效的 JWT。	`embed:session:create`
`GET`	`/public-api/v1/runtime/bootstrap`	根据嵌入 JWT 解析运行时上下文。	`Bearer 嵌入令牌`
`POST`	`/public-api/v1/runtime-bindings/sync-from-wordpress`	根据 WordPress 产品映射创建或更新运行时绑定。	`任何已验证身份的凭据`
`PATCH`	`/public-api/v1/runtime-bindings/:id`	部分更新运行时绑定。	`任何已验证身份的凭据`
`POST`	`/public-api/v1/runtime-bindings/:id/activate`	激活运行时绑定。	`任何已验证身份的凭据`
`POST`	`/public-api/v1/runtime-bindings/:id/deactivate`	停用运行时绑定。	`任何已验证身份的凭据`

店铺产品

产品端点返回可作为 Viewer、Configurator 或 Customizer 体验嵌入的店铺设计。

参数	必填	详情
`name`	`否`	搜索产品／设计名称。
`customizer`	`否`	true 或 false。
`offset`	`否`	默认为 0，必须 >= 0。
`limit`	`否`	默认为 9，最大为 50。
`order_by`	`否`	id、name 或 created_at。
`direction`	`否`	ASC 或 DESC。

请求示例（fetch）

const params = new URLSearchParams({
  limit: '20',
  offset: '0',
  name: 't-shirt',
  customizer: 'true',
  order_by: 'created_at',
  direction: 'DESC'
});

const products = await alterFetch(`/products?${params.toString()}`);
const product = await alterFetch('/products/381');

响应示例

{
  "products": {
    "items": [
      {
        "id": 381,
        "name": "Men's T-Shirt",
        "createdAt": "2026-01-03T23:55:05.000Z",
        "productId": 4,
        "media": {
          "img": {
            "big": "https://alterproduct.com/public-api/v1/file/public/products/4/big.png",
            "medium": "https://alterproduct.com/public-api/v1/file/public/products/4/medium.png",
            "small": "https://alterproduct.com/public-api/v1/file/public/products/4/small.png"
          },
          "mockups": []
        },
        "storefrontProduct": {
          "id": 89,
          "idUserDesign": 381,
          "shareAccess": "public",
          "isCustomizer": 1
        },
        "runtimeBindings": [
          {
            "id": 42,
            "runtimeType": "customizer",
            "status": "active",
            "externalProductId": "wc_123"
          }
        ],
        "embeddable": {
          "viewer": true,
          "configurator": true,
          "customizer": true
        }
      }
    ],
    "total": 1
  }
}

运行时绑定

运行时绑定将外部电商产品与 Alter Product 设计及运行时类型连接，主要用于 WordPress/WooCommerce 集成和高级店铺后端。

参数	必填	详情
`designId`	`否`	店铺拥有的 Alter Product 设计 ID。
`externalProductId`	`同步时必填`	外部产品 ID，例如 WooCommerce 产品 ID。
`runtimeType`	`同步时必填`	viewer、configurator 或 customizer。
`status`	`否`	draft、active、inactive、archived 或 legacy_active。
`legacyStorefrontProductId`	`否`	可选的旧版映射 ID。
`legacyBindingMeta`	`否`	可选的 JSON 元数据，例如 manifestHash。

请求示例（fetch）

await alterFetch('/runtime-bindings/sync-from-wordpress', {
  method: 'POST',
  body: JSON.stringify({
    bindings: [
      {
        externalProductId: 'wc_123',
        runtimeType: 'customizer',
        status: 'active',
        designId: 381,
        legacyBindingMeta: {
          manifestHash: 'a3b1...'
        }
      }
    ]
  })
});

await alterFetch('/runtime-bindings/42', {
  method: 'PATCH',
  body: JSON.stringify({
    status: 'inactive'
  })
});

await alterFetch('/runtime-bindings/42/activate', { method: 'POST' });
await alterFetch('/runtime-bindings/42/deactivate', { method: 'POST' });

wordpress_local

await alterFetch('/runtime-bindings/sync-from-wordpress', {
  method: 'POST',
  body: JSON.stringify({
    bindings: [
      {
        externalProductId: 'wc_123',
        runtimeType: 'viewer',
        status: 'active',
        externalDesign: {
          externalDesignKey: 'wp-design-381',
          productId: 4,
          title: 'WooCommerce local design',
          manifestUrl: 'https://yourstore.com/wp-content/uploads/alter/381/manifest.json',
          assetBaseUrl: 'https://yourstore.com/wp-content/uploads/alter/381/',
          manifestHash: 'a3b1...',
          sourceMeta: {
            pluginVersion: '1.2.0'
          }
        }
      }
    ]
  })
});

响应示例

{
  "message": "runtimeBinding.syncCompleted",
  "runtimeBindings": [
    {
      "id": 42,
      "designId": 381,
      "externalProductId": "wc_123",
      "runtimeType": "customizer",
      "status": "active"
    }
  ]
}

嵌入会话与运行时初始化

在服务器上创建短期嵌入令牌，传递给 iframe／运行时，然后让运行时使用 Bearer 令牌调用 bootstrap。

参数	必填	详情
`runtimeBindingId`	`推荐`	活动运行时绑定的首选标识符。
`tool`	`没有 runtimeBindingId 时必填`	designer \| viewer \| configurator \| customizer \| model-generator
`toolId`	`tool: model-generator`	本地生成器项目的正整数 ID，不是其 UUID 或 WooCommerce 产品 ID。
`origin`	`是`	呈现嵌入内容的源，例如 https://yourstore.com.
`designId`	`一个标识符`	Alter Product 设计 ID。不要与 orderId 同时使用。
`orderId`	`一个标识符`	Customizer 订单 ID。仅对 customizer 有效。
`cartKey + cartMode`	`否`	仅供 Customizer 使用的购物车上下文。cartMode 为 view 或 edit。

请求示例（fetch）

const session = await alterFetch('/embed/session', {
  method: 'POST',
  headers: {
    'x-alter-client-fingerprint': '9f1b7a5e4b3c2d1f9f1b7a5e4b3c2d1f'
  },
  body: JSON.stringify({
    runtimeBindingId: 42,
    origin: 'https://yourstore.com'
  })
});

const bootstrapResponse = await fetch('https://alterproduct.com/public-api/v1/runtime/bootstrap', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${session.token}`
  }
});

const bootstrap = await bootstrapResponse.json();
console.log({ session, bootstrap });

说明

await alterFetch('/embed/session', {
  method: 'POST',
  body: JSON.stringify({
    tool: 'customizer',
    origin: 'https://yourstore.com',
    orderId: 123
  })
});

await alterFetch('/embed/session', {
  method: 'POST',
  body: JSON.stringify({
    tool: 'viewer',
    origin: 'https://yourstore.com',
    designId: 381
  })
});

响应示例

{
  "token": "eyJhbGciOiJIUzI1NiIsImtpZCI6IjEifQ...",
  "expiresIn": 900,
  "kid": "1",
  "mode": "design",
  "runtimeBindingId": 42,
  "runtimeType": "customizer"
}

Runtime bootstrap

{
  "runtimeBindingId": 42,
  "designId": 381,
  "productId": "wc_123",
  "runtimeType": "customizer",
  "storageMode": "wordpress_local",
  "manifestUrl": "https://yourstore.com/wp-content/uploads/alter/381/manifest.json",
  "assetBaseUrl": "https://yourstore.com/wp-content/uploads/alter/381/",
  "manifestHash": "a3b1...",
  "planCapabilities": {
    "viewer": true,
    "configurator": true,
    "customizer": true
  },
  "cartKey": null,
  "cartMode": null,
  "orderId": null
}