# @characterxyz/server 中文文档

规范地址：https://npmcn.com/package/%40characterxyz/server/

版本：0\.10\.1
npm 元数据更新时间：2026-11-06T11:22:14.777Z
中文译文更新时间：2026-11-09T12:17:24.910Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：12 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-10-12T05:24:52.963Z
- 最新版本发布：2026-11-06T11:22:14.375Z
- 近 30 天下载量：2799（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

您服务器上的字符 XYZ : 用您的密钥为登录访问者薄荷会话, 并验证webhook 签名 。 节点,德诺,邦和边缘运行时间.

## 安装

```sh
npm install @characterxyz/server
```

也可以使用：`pnpm add @characterxyz/server`、`yarn add @characterxyz/server`、`bun add @characterxyz/server`

## README

# @ characterxyz/ 服务器

服务器上的字符 XYZ 。 用您的密钥为登录的访客装一个会话, 并验证 webhook 签名。 在节点18+,德诺,邦和边缘跑道工作.

```ts
import { createSession, verifyWebhook } from '@characterxyz/server';

const session = await createSession({
  secretKey: process.env.CHARACTERXYZ_SECRET_KEY!,
  visitor: { id: user.id },
  origin: 'https://www.example.com',
});
```

浏览器中永远不属于的秘密密钥 : `createSession` 拒绝一跑.

见 [仓库读取器](https://github.com/characterxyz/characterxyz-sdk#readme) 用于使用、安全和定制.

## 常见问题

### @characterxyz/server 是什么？

您服务器上的字符 XYZ : 用您的密钥为登录访问者薄荷会话, 并验证webhook 签名 。 节点,德诺,邦和边缘运行时间\.

### 如何安装 @characterxyz/server？

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

### @characterxyz/server 支持 TypeScript 吗？

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

### @characterxyz/server 支持 ESM 还是 CommonJS？

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

### @characterxyz/server 可以商用吗？

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

### @characterxyz/server 的下载量有多少？

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

### @characterxyz/server 还在维护吗？

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