@exavault/exavault-api NPM

ExaVault JavaScript API Library - v2 API

Introduction

Welcome to ExaVault's JavaScript code library for our v2 API. Our v2 API will allow you to interact with all aspects of the service the same way our web portal would. The library is generated from our API's public swagger YAML file

Requirements

To use this library Node.js should be installed in the system. We recommend using version 10 or higher.

You will also need an ExaVault account, as well as an API key and access token.

Installation

There are three installation options:

1. Install from npm registry (recommended)

npm install @exavault/exavault-api --save

2. Install from Github (use this if you cannot install from npm registry)

npm install ExaVault/evapi-javascript --save

3. Download zip archive with code

Go to ExaVault JavaScript API library homepage.
Click on Code -> Download and you will get an archive with code, which you need to unarchive to your destination folder.
Then go to the folder with library and run the following command to install all dependencies:

npm install

Now you're ready to include the library to your code and start making calls to the ExaVault API.

Sample Code

For a gentle introduction to using JavaScript code with ExaVault's API, check out our code samples. Follow the instructions in that repository's README to run the sample scripts, which will demonstrate how to use JavaScript Library to interact with your ExaVault account.

Writing Your Own Code

After you have completed the installation steps above, you're all set to write your own code. Here is an example of how to get your account information from the API.

const ExaVaultApi = require('@exavault/exavault-api');

const evApiKey = "evApiKey_example";
const evAccessToken = "evAccessToken_example";
const evAccountUrl = "https://your_account_name.exavault.com/api/v2";

// Create api object instance with account url configuration
// Note that we must provide an accountname to the API
const apiClient =   new ExaVaultApi.ApiClient();
apiClient.basePath = evAccountUrl;

const api = new ExaVaultApi.AccountApi(apiClient);

// Process response data from the API
const callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};

// Make a call to ExaVault API to get account data
api.getAccount(evApiKey, evAccessToken, {}, function(error, data) {
    // Use `data` argument to access response data
    // Use `error` argument to access any errors
});

If you'd like to see this done in sample code, please take a look at our code samples