@apideck/vue-vault

Vue Vault

A Vue component to embed Apideck Vault in any Vue application.

Vue Vault | React Vault | Vault JS

Installation

Package

npm install @apideck/vue-vault

Prerequisites

Before opening the Vault modal with vault-js, you need to create a Vault session from your backend using the Vault API or one of our SDKs. Find out more in the docs.

Usage

Pass the JWT you got from the Vault session to vue-vault:

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

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

If you want to only show integrations for a single Unified API, you can do that by passing the unifiedApi option. If you want to open Vault for only a single integration, you can provide the serviceId option.

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

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

If you want to get notified when the modal opens and closes, you can provide the onReady and onClose options.

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

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

Properties

Property	Type	Required	Default	Description
token	string	true	-	The JSON Web Token returned from the Create Session API
showAttribution	boolean	false	true	Show "Powered by Apideck" in the backdrop of the modal backdrop
onClose	event	false	-	Function that gets called when the modal is closed
onReady	event	false	-	Function that gets called when the modal is opened
unifiedApi	string	false	-	When unifiedApi is provided it will only show integrations from that API.
serviceId	string	false	-	When unifiedApi and serviceId are provided Vault opens a single integration