@apideck/vault-js

中文文档
1.8.1发布于 2026/05/13MITTypeScriptESM + CJS零依赖近 30 天下载 20.5万
中文使用文档
文档目录6 节
  1. 安装
  2. 软件包
  3. 脚本
  4. 先决条件
  5. 使用量
  6. 属性

Total Downloads Latest Stable Version

联署材料

嵌入的香草 JavaScript 库 阿皮德克·沃尔 在任何网络应用程序中.

联署材料 | 反弹 | 阴道

安装

软件包

npm install @apideck/vault-js

脚本

如果你不想建立一个建筑环境,你可以得到 @apideck/vault-js 从一个像 unpkg.com 的 CDN 中,它将通过 window.ApideckVault 对象.

<script src="https://unpkg.com/@apideck/vault-js"></script>

先决条件

在打开虚拟模式之前 @apideck/vault-js,您需要使用 Vault API 或我们中的一个 SDKs 软件中查找更多内容 文档。 。 。 .

使用量

将您从 Vault 会话得到的 JWT 传递到 @apideck/vault-js数字 :

import { ApideckVault } from '@apideck/vault-js';

ApideckVault.open({
  token: 'REPLACE_WITH_SESSION_TOKEN',
});

如果您只想要显示单个统一 API 的集成, 您可以通过 unifiedApi 选项。 如果您想要打开 Vault 只进行一个整合, 您可以提供 serviceId 选项.

import { ApideckVault } from '@apideck/vault-js';

ApideckVault.open({
  token: 'REPLACE_WITH_SESSION_TOKEN',
  unifiedApi: 'accounting',
  serviceId: 'quickbooks',
});

如果你想在模式打开和关闭时得到通知,你可以提供 onReady 财务报告和审定财务报表 onClose 选项.

import { ApideckVault } from '@apideck/vault-js';

ApideckVault.open({
  token: 'REPLACE_WITH_SESSION_TOKEN',
  onClose: () => {
    console.log('closed!');
  },
  onReady: () => {
    console.log('ready!');
  },
});

如果你想打开一个特定的视图,你可以通过 initialView 道具 (英语). 现有观点是: settings, (中文(简体) ), configurable-resources,以及 custom-mapping。 。 。 .

import { ApideckVault } from '@apideck/vault-js';

ApideckVault.open({
  token: 'REPLACE_WITH_SESSION_TOKEN',
  unifiedApi: 'accounting',
  serviceId: 'quickbooks',
  initialView: 'custom-mapping',
});

如果您想用特定语言打开保险库, 您可以通过一个本地语言 。 现有地点是: en (违约), nl, (中文(简体) ), de, (中文(简体) ), fr,以及 es。 。 。 .

import { ApideckVault } from '@apideck/vault-js';

ApideckVault.open({
  token: 'REPLACE_WITH_SESSION_TOKEN',
  locale: 'nl',
});

您也可以在模式底端显示语言切换符,设置 showLanguageSwitch 属性.

import { ApideckVault } from '@apideck/vault-js';

ApideckVault.open({
  token: 'REPLACE_WITH_SESSION_TOKEN',
  showLanguageSwitch: true,
});

如果您想使用按钮布局来代替TopBar的下放菜单来进行连接动作,可以设置 showButtonLayout 属性.

import { ApideckVault } from '@apideck/vault-js';

ApideckVault.open({
  token: 'REPLACE_WITH_SESSION_TOKEN',
  showButtonLayout: true,
});

您也可以通过调用程序关闭模式 ApideckVault.close()。 。 。 .

如果你想在模式上方显示一个标志,可以设置 logo 财产 theme 通过会话可以提供对象. 查看 API 文档。 。 。 .

属性

财产类型需求默认说明
符号字符串真实- 说吧JSON网络托肯从 创建会话 API
显示归属布尔虚假真实在模式背景中显示“ Powered by Apideck”
打开() 无效虚假- 说吧打开虚拟模式的函数
关闭() 无效虚假- 说吧关闭虚拟模式的函数
准备() 无效虚假- 说吧打开模式时调用的函数
关闭() 无效虚假- 说吧模式关闭时调用的函数
连接变化(连接: 连接) QQ 无效虚假- 说吧当用户更新连接时被调用的函数 。 这可以是连接他们的账户,填写设置或添加新连接
连接删除(连接: 连接) QQ 无效虚假- 说吧当用户删除连接时调用的函数
统一 Api字符串虚假- 说吧当提供统一Api时,它只会显示来自该API的集成.
服务编号字符串虚假- 说吧当统一 Api 和服务Id 被提供时 Vault 打开单一集成
显示消费者布尔虚假虚假如果真实, 它显示当前模式底部的消费元数据
初始视图连接视频虚假- 说吧在特定视图中打开连接符:"设置","可配置资源",或"客户映射"
语言字符串虚假"十"("十")以特定语言打开地窖:"en","nl","de","fr"或"es"
显示语言交换符布尔虚假虚假在底部显示语言切换
显示按钮Layout布尔虚假虚假在 TopBar 中使用按钮布局而不是下放菜单用于连接动作
自动启动认证布尔虚假虚假如果真实, 它会自动启动连接的授权程序 .

版本与发布记录

@apideck/vault-js 共发布 23 个版本,首次发布于 2022/12/15;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.8.1latest2026/05/135 个月前
1.8.02025/07/021.3 年前
1.7.02025/05/291.4 年前
1.6.02024/01/312 年前
1.5.22024/01/312 年前
1.5.12024/01/252 年前

关于 @apideck/vault-js 的常见问题

如何安装 @apideck/vault-js?

在项目目录运行 npm install @apideck/vault-js,或使用 pnpm add / yarn add / bun add。

@apideck/vault-js 支持 TypeScript 吗?

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

@apideck/vault-js 支持 ESM 还是 CommonJS?

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

@apideck/vault-js 需要什么版本的 Node.js?

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

@apideck/vault-js 可以商用吗?

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

@apideck/vault-js 的下载量有多少?

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

@apideck/vault-js 还在维护吗?

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