# @getyoti/sdk-sandbox 中文文档

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

版本：1\.7\.0
npm 元数据更新时间：2026-09-15T14:02:22.830Z
中文译文更新时间：2026-11-16T07:05:12.845Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40getyoti/sdk-sandbox
原文对照：https://npmcn.com/package/%40getyoti/sdk-sandbox/?lang=original
项目主页：https://github.com/getyoti/yoti-node-sdk-sandbox#readme
源码仓库：https://github.com/getyoti/yoti-node-sdk-sandbox

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

- 包体积（解压后）：2.1 MB，194 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=16
- 运行依赖：1 个
- 首次发布：2020-03-20T15:31:52.497Z
- 最新版本发布：2023-01-19T20:07:44.078Z
- 近 30 天下载量：13652（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

Yoti 节点JS 后端集成的沙盒

## 安装

```sh
npm install @getyoti/sdk-sandbox
```

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

## README

# Yoti 节点JS 沙盒 SDK

[![Build Status](https://travis-ci.com/getyoti/yoti-node-sdk-sandbox.svg?branch=master)](https://travis-ci.com/getyoti/yoti-node-sdk-sandbox) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Anode-sandbox&metric=coverage)](https://sonarcloud.io/dashboard?id=getyoti%3Anode-sandbox) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Anode-sandbox&metric=bugs)](https://sonarcloud.io/dashboard?id=getyoti%3Anode-sandbox) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Anode-sandbox&metric=code_smells)](https://sonarcloud.io/dashboard?id=getyoti%3Anode-sandbox) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=getyoti%3Anode-sandbox&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=getyoti%3Anode-sandbox)

欢迎来到Yoti节点JS Sandbox. 此repo包含测试您节点JS后端集成所需的工具.

## 所需资源

### 节点版本

请参考 [特拉维斯](https://travis-ci.com/getyoti/yoti-node-sdk-sandbox) 以查看所有兼容的节点版本.

## 安装沙盒

要在您的项目中导入 Yoti SDK, 您可以使用您最喜欢的依赖管理系统 . 使用国家防范机制时,可以使用以下命令设置"Yoti Sandbox SDK"作为依赖: 1

```shell
npm install @getyoti/sdk-sandbox
```

## 配置

-   `SANDBOX_CLIENT_SDK_ID` 是 Yoti Hub 创建您的应用程序时在 Key 标签中生成的 SDK 标识符 .
    
-   `/path/to/your-pem-file.pem` 是程序 pem 文件的路径。 它只能从你的Yoti枢纽的 Keys 标签上下载一次.
    

请不要打开 pem 文件, 因为这会损坏密钥, 您需要重新创建 Yoti 枢纽上的密钥 .

### 简介

#### Yoti 客户端

通过设置环境变量将 Yoti 客户端指向沙盒 `YOTI_API_URL` 改为 [https://api.yoti.com/sandbox/v1 (英语)](https://api.yoti.com/sandbox/v1)

```javascript
const { Client } = require('yoti');
const fs = require('fs');

const SANDBOX_CLIENT_SDK_ID = 'SANDBOX_CLIENT_SDK_ID';
const PEM = fs.readFileSync('/path/to/your-pem-file.pem', 'utf8');

const yotiClient = new Client(SANDBOX_CLIENT_SDK_ID, PEM);
```

#### 配置 sandbox 客户端

```javascript
const { SandboxProfileClientBuilder } = require('@getyoti/sdk-sandbox');

const sandboxProfileClient = new SandboxProfileClientBuilder()
  .withClientSdkId(SANDBOX_CLIENT_SDK_ID)
  .withPemString(PEM)
  .build();
```

### 身份证

#### IDV 客户端

通过设置环境变量将IDV客户端指向沙盒 `YOTI_IDV_API_URL` 改为 [https://api.yoti.com/sandbox/idvirify/v1 页面存档备份,存于互联网档案馆](https://api.yoti.com/sandbox/idverify/v1)

```javascript
const { IDVClient } = require('yoti');
const fs = require('fs');

const SANDBOX_CLIENT_SDK_ID = 'SANDBOX_CLIENT_SDK_ID';
const PEM = fs.readFileSync('/path/to/your-pem-file.pem', 'utf8');

const idvClient = new IDVClient(SANDBOX_CLIENT_SDK_ID, PEM);
```

#### IDV 沙盒客户端

```javascript
const { SandboxIDVClientBuilder } = require('@getyoti/sdk-sandbox');

const sandboxClient = new SandboxIDVClientBuilder()
  .withClientSdkId(SANDBOX_CLIENT_SDK_ID)
  .withPemString(PEM)
  .build();
```

## 实例

-   [配置文件沙盒](https://npmcn.com/package/%40getyoti/sdk-sandbox/examples/profile)
-   [IDV 沙盒](https://npmcn.com/package/%40getyoti/sdk-sandbox/examples/idv)

## 常见问题

### @getyoti/sdk-sandbox 是什么？

Yoti 节点JS 后端集成的沙盒

### 如何安装 @getyoti/sdk-sandbox？

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

### @getyoti/sdk-sandbox 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/getyoti\_\_sdk-sandbox 是否存在。

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

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

### @getyoti/sdk-sandbox 可以商用吗？

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

### @getyoti/sdk-sandbox 的下载量有多少？

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

### @getyoti/sdk-sandbox 还在维护吗？

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

