# @ampsec/platform-client 中文文档

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

版本：89\.3\.12
npm 元数据更新时间：2026-11-05T19:46:12.645Z
中文译文更新时间：2026-11-06T08:36:45.125Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：2.6 MB，834 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- 首次发布：2023-05-16T15:50:53.262Z
- 最新版本发布：2026-11-05T19:46:12.420Z
- 近 30 天下载量：3795（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：589（近 12 个月 125 个）

## 中文简介

收集我们平台API使用的数据模型、公用事业和客户端.

## 安装

```sh
npm install @ampsec/platform-client
```

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

## README

# 放大器安全 - 平台客户端

收集我们平台API使用的数据模型、公用事业和客户端.

## 条目点

### API 客户端

-   探员
    -   [src/services/AmpApi.ts (中文(简体) )](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpApi.html)
-   服务账户
    -   [src/服务/AmpSdk.ts](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpSdk.html)
-   结束用户
    -   [斜弧/服务/引擎Api.ts](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpSdk.html)

### 服务

-   设置
    -   [服务 - 服务/服务/设置.服务.ts](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpSettingsService.html)
    -   [AmpSettingsMap - src/services/sets.services.ts.ts (中文(简体) )](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/classes/AmpSettingsMap.html)

### 数据

-   [模块](https://amplifier-security.gitlab.io/ampsec-platform/amp-platform-client/modules.html)
    -   编号

## 开始

```ts
import {UpsertUserDto} from '@ampsec/platform-client'

async function testAgentApi() {
    const agentApi = AmpApi.instance({
        baseUrl: process.env.PLATFORM_API_URL,
        token: process.env.PLATFORM_TOKEN,
    })
    const me = await agentApi.identity.me();
    console.log(me);
}

async function testAgentApi() {
    const sdk = AmpSdkServices.instance({
        baseUrl: process.env.PLATFORM_API_URL,
        token: process.env.PLATFORM_TOKEN,
    })
    const me = await agentApi.identity.me();
    console.log(me);
}
```

## 发展

见 [发展.md](https://npmcn.com/package/%40ampsec/platform-client/DEVELOPMENT.md)

## 常见问题

### @ampsec/platform-client 是什么？

收集我们平台API使用的数据模型、公用事业和客户端\.

### 如何安装 @ampsec/platform-client？

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

### @ampsec/platform-client 支持 TypeScript 吗？

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

### @ampsec/platform-client 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @ampsec/platform-client 可以商用吗？

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

### @ampsec/platform-client 的下载量有多少？

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

### @ampsec/platform-client 还在维护吗？

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

