# @zinn-digital/sdk 中文文档

规范地址：https://npmcn.com/package/%40zinn-digital/sdk/

版本：0\.1\.1372
npm 元数据更新时间：2026-11-03T00:34:38.386Z
中文译文更新时间：2026-11-03T00:39:21.605Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40zinn-digital/sdk
原文对照：https://npmcn.com/package/%40zinn-digital/sdk/?lang=original
项目主页：https://zinndigital.com/developers/sdk-typescript

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

- 包体积（解压后）：9.4 MB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-11-01T10:57:48.816Z
- 最新版本发布：2026-11-03T00:34:38.209Z
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

Zinn数字平台API的类型化TypeScript客户端，从它的OpenAPI规范生成。

## 安装

```sh
npm install @zinn-digital/sdk
```

也可以使用：`pnpm add @zinn-digital/sdk`、`yarn add @zinn-digital/sdk`、`bun add @zinn-digital/sdk`

## README

# @zinn-digital/sdk - Zinn Digital平台API的TypeScript客户端

的完整类型客户端 [津恩数码](https://zinndigital.com/developers/sdk-typescript) 公共API。每条路径, 参数和响应类型是从平台的OpenAPI规范生成的，新版本是 在规范更改时自动发布。

```bash
npm install @zinn-digital/sdk
```

```ts
import { createApiClient } from "@zinn-digital/sdk";

const api = createApiClient({ baseUrl: "https://api.zinndigital.com" });

// Public catalogue endpoints need no key.
const { data: regions } = await api.GET("/v1/catalog/regions");

// Everything else uses a per-organisation API key (create one on the dashboard's API keys page).
api.use({
  onRequest: ({ request }) => {
    request.headers.set("Authorization", `Bearer ${process.env.ZINN_API_KEY}`);
  },
});
const { data: sites, error } = await api.GET("/v1/sites");
```

客户端是 [openapi-fetch](https://openapi-ts.dev/openapi-fetch)； `components`， `paths` 和 `operations` 为您自己的代码导出类型(`import type { components } from "@zinn-digital/sdk"`）。

-   导游: [https://zinndigital.com/developers/sdk-typescript](https://zinndigital.com/developers/sdk-typescript)
-   API参考: [https://zinndigital.com/developers/api](https://zinndigital.com/developers/api)
-   执照:麻省理工学院

## 常见问题

### @zinn-digital/sdk 是什么？

Zinn数字平台API的类型化TypeScript客户端，从它的OpenAPI规范生成。

### 如何安装 @zinn-digital/sdk？

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

### @zinn-digital/sdk 支持 TypeScript 吗？

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

### @zinn-digital/sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @zinn-digital/sdk 需要什么版本的 Node\.js？

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

### @zinn-digital/sdk 可以商用吗？

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

### @zinn-digital/sdk 还在维护吗？

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