@getvouch/sdk

中文文档
0.3.0发布于 2026/07/23TypeScriptES Module零依赖近 30 天下载 6.3万

邮袋 SDK

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 获取数据源 URL
  4. 获取部件 URL

邮袋 SDK

Static Badge

这是Vouch SDK,一个用于与Vouch互动的TypeScript库. 目前,它允许您创建链接来启动网络证明流或将用户引导到部件页面.

安装

要安装Vouch SDK,可以使用npm或其他软件包管理器.

npm install @getvouch/sdk
yarn add @getvouch/sdk
pnpm add @getvouch/sdk
bun add @getvouch/sdk

使用量

与您创建 Vouch 实例 customerId 财务报告和审定财务报表 apiKey数字 :

import { Vouch } from "@getvouch/sdk";
const vouch = new Vouch({
  customerId: "customer-id", // Your unique customer ID.
  apiKey: "your-api-key", // Your API key for authentication.
});

您也可以提供额外的配置选项 :

import { Vouch } from "@getvouch/sdk";
const vouch = new Vouch({
  customerId: "customer-id",
  apiKey: "your-api-key",
  vouchHost: "https://app.getvouch.io", // The base URL for the Vouch API. Can be a string or an URL object. Defaults to "https://app.getvouch.io".
});

获取数据源 URL

创建启动 Vouch 流量的链接。 。 。 .

const { verificationUrl, requestId } = await vouch.getDataSourceUrl({
  datasourceId: "93826be6-6c7d-495a-9859-de5a1d17f30b", // Datasource ID. Here we use example.com data source. Must be a UUIDv4.
  redirectBackUrl: "https://docs.getvouch.io/getting-started/first-steps", // Return destination.
  webhookUrl: "https://docs.getvouch.io/api/web-proof", // (Optional) Proof delivery endpoint.
  requestId: "your-uuid-v4", // (Optional) Provide your own UUIDv4 to use as the proof request ID. If omitted, the server generates one.
});

添加输入

更多地了解投入。 。 。 .

假设您想要使用以下输入方案的数据源 :

{
  name: string;
  minFollowersCount: number;
}

然后在生成数据源 URL 时需要提供输入 :

const { verificationUrl, requestId } = await vouch.getDataSourceUrl({
  /// ...similar to the previous example
  inputs: {
    name: "John Doe",
    minFollowersCount: 1337,
  },
});

输入会被编码为基数64,所以在URL内部可以看到类似的东西: inputs=eyJuYW1lIjoiSm9obiBEb2UiLCJtaW5Gb2xsb3dlcnNDb3VudCI6MTMzN30

获取部件 URL

生成一个链接到一个部件页面, 用户可以从可用数据源中选择 。 要求数 customerId 财务报告和审定财务报表 apiKey 在建筑师.

const { verificationUrl, requestId } = await vouch.getWidgetUrl({
  widgetId: "41b9a0c3-1234-4678-9abc-def012345678", // Your widget ID. Must be a UUIDv4.
  redirectBackUrl: "https://example.com/callback", // Return destination after proof completion.
  webhookUrl: "https://example.com/webhook", // (Optional) Proof delivery endpoint.
});

版本与发布记录

@getvouch/sdk 共发布 10 个版本,首次发布于 2025/06/20;过去 12 个月发布了 6 个版本。

版本发布日期距今
0.3.0latest2026/07/233 个月前
0.2.02026/05/156 个月前
0.1.72026/03/197 个月前
0.1.62026/03/038 个月前
0.1.52026/02/198 个月前
0.1.42026/02/099 个月前

关于 @getvouch/sdk 的常见问题

@getvouch/sdk 是什么?

邮袋 SDK

如何安装 @getvouch/sdk?

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

@getvouch/sdk 支持 TypeScript 吗?

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

@getvouch/sdk 支持 ESM 还是 CommonJS?

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

@getvouch/sdk 可以商用吗?

@getvouch/sdk 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@getvouch/sdk 的下载量有多少?

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

@getvouch/sdk 还在维护吗?

最新版本 0.3.0 发布于 2026/07/23(3 个月前);至今共发布 10 个版本,其中过去 12 个月发布了 6 个;首次发布于 2025/06/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。