# @commercebuild/platform-api 中文文档

规范地址：https://npmcn.com/package/%40commercebuild/platform-api/

版本：0\.11\.33
npm 元数据更新时间：2026-11-08T21:43:05.795Z
中文译文更新时间：2026-11-10T11:56:39.465Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40commercebuild/platform-api
原文对照：https://npmcn.com/package/%40commercebuild/platform-api/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：450 kB，90 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2025-07-17T23:26:30.064Z
- 最新版本发布：2026-07-28T04:37:27.437Z
- 近 30 天下载量：4278（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 3 个）

## 中文简介

商务建设平台 API

## 安装

```sh
npm install @commercebuild/platform-api
```

也可以使用：`pnpm add @commercebuild/platform-api`、`yarn add @commercebuild/platform-api`、`bun add @commercebuild/platform-api`

## README

# @ commercialbuilding/ platform- api

JavaScript / TypeScript 客户端库 [商业建设](https://www.commercebuild.com/) 平台服务. 在Node.js(QQ22)和现代浏览器中工作,有本地 [获取 API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)。包括类型脚本类型定义.

## 安装

### npm/ 纱线/ pnpm

```bash
npm install @commercebuild/platform-api
# or
yarn add @commercebuild/platform-api
# or
pnpm add @commercebuild/platform-api
```

### CDN( 平面 HTML)

```html
<script src="https://unpkg.com/@commercebuild/platform-api@0.0.6/dist/platform-api.min.js"></script>
```

或者通过jsDelivr:

```html
<script src="https://cdn.jsdelivr.net/npm/@commercebuild/platform-api@0.0.6/dist/platform-api.min.js"></script>
```

库作为一个全球变量被曝光 `CommercebuildPlatform`。 。 。 .

## 快速启动

### 基于 Bundler 的项目( React, Vue, Next.js, Vite等)

```typescript
import {createApi} from '@commercebuild/platform-api';

const api = createApi({
  rootUrl: 'https://platform.yourdomain.com',
  storeId: 'your-store-id',
  accessToken: 'your-access-token',
});

const customer = await api.customer().getUserSelf();
console.log(customer);
```

### 通过 CDN 的普通 HTML

```html
<script src="https://unpkg.com/@commercebuild/platform-api@0.0.6/dist/platform-api.min.js"></script>
<script>
  const api = CommercebuildPlatform.createApi({
    rootUrl: 'https://platform.yourdomain.com',
    storeId: 'your-store-id',
    accessToken: 'your-access-token',
  });

  api.customer().getUserSelf().then(console.log);
</script>
```

### 商业建设商店前页

```html
<script src="https://unpkg.com/@commercebuild/platform-api@0.0.6/dist/platform-api.min.js"></script>
<script>
  const api = CommercebuildPlatform.createWebApiInStoreV4({
    storeId: 'your-store-id',
    uniqueId: 'myPlatformApi',
  });
</script>
```

## 认证

该图书馆支持几个符号策略:

```typescript
createApi({
  rootUrl: 'https://platform.yourdomain.com',
  storeId: 'your-store-id',

  // Option 1: static token
  accessToken: 'eyJhbGc...',

  // Option 2: dynamic token (sync or async)
  // accessToken: async () => fetchTokenFromSomewhere(),

  // Option 3: auto-refresh on 401
  // refreshAccessToken: async () => fetchNewToken(),
});
```

打开 `401 Unauthorized`,如果 `refreshAccessToken` 以新符号自动重审请求并发出 a `TokenUpdatedByRefreshAccessToken` 活动.

## 可用服务

```typescript
api.cart()         // shopping cart (v1, v2)
api.catalog()      // product catalog
api.checkout()     // checkout flow
api.customer()     // customer profiles
api.files()        // file storage
api.grid()         // pricing grids
api.notification() // notifications
api.oauth()        // OAuth tokens
api.order()        // orders, quotes, shipments, transactions
api.payment()      // payment processors
api.price()        // pricing
api.promotion()    // promotions / coupons
api.setting()      // platform settings
api.shipping()     // shipping methods
api.stock()        // inventory
api.sync()         // integration sync
```

每个服务都有版本. 使用 `api.cart('2')` 连接到特定版本.

## API 版本

```typescript
const cartV1 = api.cart('1');
const cartV2 = api.cart('2');
const cart   = api.cart(); // defaults to v1
```

## 活动

```typescript
api.on('TokenUpdated', (token) => { /* refresh-token flow succeeded */ });
api.on('TokenInvalid', () => { /* both access + refresh expired */ });
```

## 类型脚本

完整类型定义被捆绑. 所有请求/响应形状都被输入 .

## 许可证

[麻省理工学院](https://npmcn.com/package/%40commercebuild/platform-api/LICENSE)

## 常见问题

### @commercebuild/platform-api 是什么？

商务建设平台 API

### 如何安装 @commercebuild/platform-api？

在项目目录运行 npm install @commercebuild/platform-api，或使用 pnpm add / yarn add / bun add。

### @commercebuild/platform-api 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @commercebuild/platform-api 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @commercebuild/platform-api 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @commercebuild/platform-api 可以商用吗？

@commercebuild/platform-api 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @commercebuild/platform-api 的下载量有多少？

根据 npm 官方下载统计，@commercebuild/platform-api 在 2026/10/11 – 2026/11/09 这 30 天内被下载 4,278 次，日均约 143 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @commercebuild/platform-api 还在维护吗？

最新版本 0\.11\.33 发布于 2026/07/28（3 个月前）；至今共发布 7 个版本，其中过去 12 个月发布了 3 个；首次发布于 2025/07/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。