@evervault/sdk

Evervault Node SDK

The Node.js SDK for working with Evervault Cages.

Prerequisites

To get started with the Evervault Node.js SDK, you will need to have created a team on the Evervault Dashboard.

We are currently in invite-only early access. You can apply for early access here.

Installation

npm install --save @evervault/sdk

yarn add @evervault/sdk

Setup

const Evervault = require('@evervault/sdk');

// Initialize the client with your team's api key
const evervaultClient = new Evervault('<API-KEY>');

// Encrypt your sensitive data
const encrypted = await evervaultClient.encrypt({ ssn: '012-34-5678' });

// Process the encrypted data in a Cage
const result = await evervaultClient.run('<CAGE_NAME>', encrypted);

API Reference

evervaultClient.encrypt

Encrypt lets you encrypt data for use in any of your Evervault Cages. You can use it to store encrypted data to be used in a Cage at another time.

async evervaultClient.encrypt(data: Object | String);

Parameter	Type	Description
data	Object or String	Data to be encrypted

evervaultClient.run

Run lets you invoke your Evervault Cages with a given payload.

async evervaultClient.run(cageName: String, payload: Object, options?: Object);

Parameter	Type	Description
cageName	String	Name of the Cage to be run
data	Object	Payload for the Cage
options	Object	Options for the Cage run

Cage Run Options

Options to control how your Cage is run

Option	Type	Default	Description
async	Boolean	false	Run your Cage in async mode. Async Cage runs will be queued for processing.
version	Number	undefined	Specify the version of your Cage to run. By default, the latest version will be run.