Skip to content

ExaVault/evapi-java

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
src
 
 
 
 
 
 
 
 
 
 

ExaVault Java API Library - v2 API

Introduction

Welcome to ExaVault's Java 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, you'll need Java 1.8+ and Maven.

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

Setting Up

Clone the project from our repository

git clone https://github.com/ExaVault/evapi-java.git

As a next step, import the project into your favorite Java IDE. Please refer to this guide to install an IDE and import the project into it.

Compiling and Installing the Code Library

Option 1 - Using Maven

As a first step, you need to install our Java SDK into your local maven repository. To do so, please run the following command from the root folder (where you've imported/cloned our Java SDK).

mvn clean -DskipTests=true install

Now, our Java SDK and its related dependencies are installed into your local maven repository.

Furthermore, Add this dependency to your project's POM.XML:

<dependency>
  <groupId>com.exavault</groupId>
  <artifactId>exavault-api-client</artifactId>
  <version>INSERT_VERSION_NUMBER_HERE</version>
  <scope>compile</scope>
</dependency>

At the end of this step, your project should be able to use our Java SDK.

Option 1a - Running Tests During Build

While you don't need to do this strictly to build our SDK, you may want to run our test suite before building. To do so, you'll need to create an API key and access token in your account, and add them to the ApiTestData.java file.

Once you've done that, to just run tests:

mvn clean test

To run tests and do a full build:

mvn clean install

Option 2 - Manual Installation

We've provided pre-compiled jar files in the lib directory. You may manually install these files into your project. Please follow this guide to configure jar files.

If you'd like to build the jar package from source, you may do:

mvn clean -DskipTests=true package

This step will generate JAR files from our SDK (and other related dependencies) into the target folder at the project root. Generally, you can just use the compiled JAR files (or use maven), but if you want to build yourself, you can.

Sample Code

For a gentle introduction to using Java code with ExaVault's API, check out our code samples. Follow the instructions in that repository's README to run the sample project, which will demonstrate how to use several of the generated Java classes to interact with your ExaVault account.

Writing Your Own Code

When you're ready to write your own code using this library, you'll need to:

  1. Install our code library in your project, using above instructions in Installation section.
  2. Provide your API key and access token with every function method on the Api classes, which are in com.exavault.client.api.* namespace.
  3. Whenever you instantiate an Api object (ResourcesApi, UsersApi, etc.), override the configuration to point the code at the correct API URL:
public static String apiUrl = "https://YOUR_ACCOUNT_NAME_HERE.exavault.com/api/v2/";

ApiClient apiClient = new ApiClient();
apiClient.setBasePath(apiUrl); 

AccountApi accountApiInstance = new AccountApi(apiClient);

Author

support@exavault.com