# @axivoy/api 中文文档

规范地址：https://npmcn.com/package/%40axivoy/api/

版本：2\.53\.0
npm 元数据更新时间：2026-11-07T04:33:38.804Z
中文译文更新时间：2026-11-07T16:09:18.476Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40axivoy/api
原文对照：https://npmcn.com/package/%40axivoy/api/?lang=original
项目主页：https://app.axivoy.ai/developers
源码仓库：https://github.com/meesam-cmd/tooli-middleware

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

- 包体积（解压后）：7.4 MB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-10-19T04:17:01.060Z
- 最新版本发布：2026-11-07T04:33:38.652Z
- 近 30 天下载量：5297（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：59（近 12 个月 59 个）

## 中文简介

为 Axivoy API 输入客户端:操作,webhooks和出错.

## 安装

```sh
npm install @axivoy/api
```

也可以使用：`pnpm add @axivoy/api`、`yarn add @axivoy/api`、`bun add @axivoy/api`

## README

# @ axivoy/ api (英语)

输入客户端 [轴心API](https://app.axivoy.ai/developers):每次已公布的操作,webhook有效载荷类型,拒绝作为出错和webhook签名检查. 从公开的 OpenAPI 引用中生成; 没有运行时依赖性 .

```typescript
import { clientCredentials, createAxivoyClient } from '@axivoy/api';

const axivoy = createAxivoyClient({
  token: clientCredentials({ clientId: process.env.AXIVOY_CLIENT_ID!, clientSecret: process.env.AXIVOY_CLIENT_SECRET! }),
});

const page = await axivoy.call('loads.list', { limit: 25 });
```

指南 : [客户端库](https://app.axivoy.ai/developers/guides/client-libraries). Node 20+, Deno, Bun 和浏览器.

## 维护者

源代码位于 Axivoy TMS 存储器 `clients/typescript` 并被释放 `client-libraries` 引用更改时的工作流程 . `npm run generate` 重建 `src/generated/schema.ts` 从 `docs/api/openapi-public.json`· ; `npm run build`, (中文(简体) ), `npm test`· ; `npm run smoke` 运行在活安装上(参见 `scripts/smoke.mjs`) (中文(简体) ).

## 常见问题

### @axivoy/api 是什么？

为 Axivoy API 输入客户端:操作,webhooks和出错\.

### 如何安装 @axivoy/api？

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

### @axivoy/api 支持 TypeScript 吗？

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

### @axivoy/api 支持 ESM 还是 CommonJS？

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

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

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

### @axivoy/api 可以商用吗？

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

### @axivoy/api 的下载量有多少？

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

### @axivoy/api 还在维护吗？

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