联署材料
嵌入的香草 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 中使用按钮布局而不是下放菜单用于连接动作 |
| 自动启动认证 | 布尔 | 虚假 | 虚假 | 如果真实, 它会自动启动连接的授权程序 . |