# @alloyidentity/web-sdk 中文文档

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

版本：2\.16\.0
npm 元数据更新时间：2026-10-05T21:39:05.750Z
中文译文更新时间：2026-11-05T21:08:05.685Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：643 kB，38 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.20
- 运行依赖：3 个
- 首次发布：2020-04-04T18:08:32.432Z
- 最新版本发布：2026-10-05T21:39:05.573Z
- 近 30 天下载量：81297（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：129（近 12 个月 38 个）

## 中文简介

合金网络文档 SDK

## 安装

```sh
npm install @alloyidentity/web-sdk
```

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

## README

# 🔐合金 SDK

**[合金](https://alloy.com/)** 帮助顶级银行和金融技术公司利用单一的API和仪表板来管理KYC/AML,欺诈等等做出更好的决定.

## 安装

对于 npm 用户 :

```shell
npm install @alloyidentity/web-sdk
```

对于 pnpm 用户 :

```shell
pnpm add @alloyidentity/web-sdk
```

对于线条用户 :

```shell
yarn add @alloyidentity/web-sdk
```

## 文档

[https://developer.alloy.com/public/docs/docs-document-verification-web-sdk 互联网档案馆的存檔,存档日期2013-12-21](https://developer.alloy.com/public/docs/document-verification-web-sdk)

## 本地测试

沿着下面的步骤运行 SDK 本地!

### 安装依赖关系

从寄存器根 :

```shell
npm install
```

### 输入参数

编辑 [`example/src/App.jsx`](https://npmcn.com/package/%40alloyidentity/web-sdk/example/src/App.jsx) 带有相应参数的文件 :

```javascript
const alloyInitParams = {
  key: '<your-sdk-key>',
  journeyToken: '<your-journey-token>',
  journeyApplicationToken: '<your-journey-application-token>',
};
```

### B. 环境和API目标

默认情况下,SDK指向了合金的主机端点(参见: [`src/config.ts`](https://npmcn.com/package/%40alloyidentity/web-sdk/src/config.ts):

-   SDK UI(框架) : `https://alloysdk.alloy.co/`
-   API : (英语) `https://docv-prod-api.alloy.co/`

覆盖这些在 `alloy.init()` 在对特定的合金环境进行测试时:

```javascript
const alloyInitParams = {
  key: '<your-sdk-key>',
  journeyToken: '<your-journey-token>',
  journeyApplicationToken: '<your-journey-application-token>',
  apiUrl: 'https://corekube-dev-alloysdk.api.alloy.com/',
  appUrl: 'https://corekube-dev-alloysdk.app.alloy.com/',
};
```

### 在浏览器中运行 SDK

这个 [`example/`](https://npmcn.com/package/%40alloyidentity/web-sdk/example/) app是一个小的 React app,通过此程序加载本地的 SDK 构建 `"alloy": "file:.."`。 。 。 .

从寄存器根运行示例应用程序 :

```shell
npm run build
cd example
npm install
npm start
```

打开 [http://localhost:3:00 (英语)](http://localhost:3000/)

## 常见问题

### @alloyidentity/web-sdk 是什么？

合金网络文档 SDK

### 如何安装 @alloyidentity/web-sdk？

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

### @alloyidentity/web-sdk 支持 TypeScript 吗？

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

### @alloyidentity/web-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

### @alloyidentity/web-sdk 可以商用吗？

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

### @alloyidentity/web-sdk 的下载量有多少？

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

### @alloyidentity/web-sdk 还在维护吗？

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