# @dynamic-labs/sdk-api 中文文档

规范地址：https://npmcn.com/package/%40dynamic-labs/sdk-api/

版本：0\.173\.0
npm 元数据更新时间：2026-11-12T20:40:14.826Z
中文译文更新时间：2026-11-13T02:23:43.928Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40dynamic-labs/sdk-api
原文对照：https://npmcn.com/package/%40dynamic-labs/sdk-api/?lang=original
项目主页：https://dynamic.xyz/

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

- 包体积（解压后）：10.5 MB，3413 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2022-05-07T14:50:15.566Z
- 最新版本发布：2026-11-12T20:40:14.597Z
- 近 30 天下载量：87615（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：1279（近 12 个月 467 个）

## 中文简介

API SDK for app.动力学.xyz

## 安装

```sh
npm install @dynamic-labs/sdk-api
```

也可以使用：`pnpm add @dynamic-labs/sdk-api`、`yarn add @dynamic-labs/sdk-api`、`bun add @dynamic-labs/sdk-api`

## README

# sdk - api (英语)

此库包含一个生成的 TypeScript 客户端 [打开](https://spec.openapis.org/oas/v3.0.1)。它可用于任何Javascript/Typescript项目.

有关当前 REST API 的文档可参见: [https://动态.xyz/docs/api-参考/概览](https://dynamic.xyz/docs/api-reference/overview)

# APIs 密码

-   斯德克阿皮语Name
    -   这些是专供 [动态反应 SDK](https://www.npmjs.com/package/@dynamic-labs/sdk-react)。这些API的几个终点需要: [日本](https://dynamic.xyz/docs/react-sdk/references/user-payload#-the-jwt-update) 创建于 `verify` 或者说 `signin` 端点,是SDK环境中用户特有的. 这些API一般被用在一个客户网站或前端来增强客户的经验.
-   盘片 API
    -   这些端点被一个组织的管理人员用来更新网站设置和管理环境用户. 这些API需要 [API 令牌](https://dynamic.xyz/docs/api-reference/overview#authentication) 适用于特定环境。 这些API一般被用在一个客户端后端上,用来管理其所有用户的数据,并做出相应的设置变化来影响一个站点的所有用户.
    -   在仪表板API中最常用的API是: `UsersApi`
    -   您可以读取其他所有可用的 API [这里](https://dynamic.xyz/docs/api-reference/overview)

# 实例

本节举例说明如何使用 `SDKApi`。这与使用其他可用的生成的API类似,例如 `UsersApi` 或者说 `ExportsApi`等 (中文(简体) ).

### 斯德克阿皮语Name

初始化一个新实例 `SDKApi` 类 :

```typescript
import { Configuration, SDKApi } from '@dynamic-labs/sdk-api';

const sdkApi = (jwt: string) => {
  const settings = {
    basePath: ApiEndpoint.getBaseUrl(),
    headers: {
      'Content-Type': 'application/json',
    },
  };
  settings.headers.Authorization = `Bearer ${jwt}`;
  return new SDKApi(new Configuration(settings));
};
```

这样你就能用到它了

```typescript
const response = await sdkApi(jwt).updateSelf({
  environmentId,
  userFields: fields, // { alias, firstName, lastName, username, ... }
});
// do something with the response
```

## 常见问题

### @dynamic-labs/sdk-api 是什么？

API SDK for app\.动力学\.xyz

### 如何安装 @dynamic-labs/sdk-api？

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

### @dynamic-labs/sdk-api 支持 TypeScript 吗？

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

### @dynamic-labs/sdk-api 支持 ESM 还是 CommonJS？

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

### @dynamic-labs/sdk-api 可以商用吗？

@dynamic-labs/sdk-api 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dynamic-labs/sdk-api 的下载量有多少？

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

### @dynamic-labs/sdk-api 还在维护吗？

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