# @authress/sdk 中文文档

规范地址：https://npmcn.com/package/%40authress/sdk/

版本：3\.2\.289
npm 元数据更新时间：2026-09-26T20:35:00.688Z
中文译文更新时间：2026-11-07T06:11:44.631Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40authress/sdk
原文对照：https://npmcn.com/package/%40authress/sdk/?lang=original
项目主页：https://authress.io/
源码仓库：https://github.com/Authress/authress-sdk.js

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

- 包体积（解压后）：153 kB，49 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：4 个
- peer 依赖：@aws-sdk/client-kms \>=3
- 首次发布：2024-01-15T19:10:19.713Z
- 最新版本发布：2026-09-26T20:35:00.364Z
- 近 30 天下载量：6672（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：89（近 12 个月 41 个）

## 中文简介

Authress授权客户SDK作为服务. 提供管理授权 api 以获取包括用户数据在内的服务资源 .

## 安装

```sh
npm install @authress/sdk
```

也可以使用：`pnpm add @authress/sdk`、`yarn add @authress/sdk`、`bun add @authress/sdk`

## README

![Authress media banner](https://authress.io/static/images/linkedin-banner.png)

# Javascript/ Typescript 的认证SDK

[![](https://badge.fury.io/js/@authress%2Fsdk.svg)](https://www.npmjs.com/package/@authress/sdk) [![](https://github.com/Authress/authress-sdk.js/actions/workflows/build.yml/badge.svg)](https://github.com/Authress/authress-sdk.js/actions/workflows/build.yml) [![](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/Authress/authress-sdk.js/blob/main/LICENSE) [![](https://img.shields.io/badge/Community-Authress-fbaf0b.svg)](https://authress.io/community)

这是Authress SDK 用于作为服务供应商Authress at [https://authress.io (英语)](https://authress.io/)。 。 。 .

## 使用量

```sh
npm install @authress/sdk
```

然后要求软件包:

```js
import { AuthressClient } from '@authress/sdk';
```

## 开始

### 参考指南

常见被执行的有描述的块的例子参见SDK参考指南.

[SDK 文档](https://github.com/Authress/authress-sdk.js/blob/main/docs/README.md)

### 方法文档

-   [使用用户令牌授权](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#authorize-using-a-user-token)
-   [用服务客户端授权](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#authorize-with-a-service-client)
-   [创造资源](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#creating-resources)
-   [使用符号验证符验证一个符号](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#verifying-a-token-using-the-token-verifier)
-   [直接提出 API 请求](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#make-direct-api-requests)
-   [通过收藏资源开始](https://github.com/Authress/authress-sdk.js/blob/main/docs/methods.md#paginating-through-a-collection-resource)

### 经常被问到的问题

-   我从哪里得到用户身份?

每个JWT都包含一个用户ID, 你可以从那里拉出来使用 `TokenVerifier` 导入或 `verifyToken` 方法。 详情见 [授权 JWT 访问符](https://authress.io/knowledge-base/docs/authentication/validating-jwts#authress-user-ids-and-a-jwt-access-token-example)。 。 。 .

### 框架实例

看见所有可用的 [认证启动套件](https://github.com/search?q=org%3AAuthress+starter-kit&type=repositories)

-   [快递](https://github.com/Authress/express-starter-kit)
-   [所有其他框架](https://github.com/search?q=org%3AAuthress+starter-kit&type=repositories)

## 捐款

[为 Javascript SDK 开发](https://github.com/Authress/authress-sdk.js/blob/main/contributing.md)

## 常见问题

### @authress/sdk 是什么？

Authress授权客户SDK作为服务\. 提供管理授权 api 以获取包括用户数据在内的服务资源 \.

### 如何安装 @authress/sdk？

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

### @authress/sdk 支持 TypeScript 吗？

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

### @authress/sdk 支持 ESM 还是 CommonJS？

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

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

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

### @authress/sdk 可以商用吗？

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

### @authress/sdk 的下载量有多少？

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

### @authress/sdk 还在维护吗？

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