Getting started with ExaVault's API

ExaVault uses a RESTful API, which supports both GET and POST operations. The below tutorial will walk you through making various API calls with our interactive API browser, and in the process give you a hint of what is possible with our developer tools.

Step 1: Obtain your API key

You will need to obtain an API key for your application, and you will of course need to have an ExaVault account in order to access the API. To obtain an API key, please follow the instructions below.

  • Login to the Accounts section of the Client Area
  • Use the drop down next to your desired account, and select "Manage API keys"
  • You will be brought to the API Key management screen. Fill out the form and save to generate a new key for your app.

Step 2: Set your API key

Once you have obtained your API key, all you need to do is paste it in the designated field on the interactive API documentation page. Now, you should be able to make API calls and receive a response from the server. However, you still need to login to obtain an access token; this will enable you to get to the business of managing your files and users.

Step 3: Authenticate and get access token

To login, you will need to use the authenticateUser method shown below. Expand the operation to access implementation details and to send an API request. To set it up, you will want to insert your username and password and hit the "Try it out!" button. After hitting this button, the API will send a response, which should be displayed for you. If all was successful, the response body should contain an access token; copy this access token for each API operation where it is required.

Step 4: Have fun!

And that's it! Now that you have authenticated into the API and both your API key and access token are set, you should be able to experiment with any of the operations listed in our API documentation. Try creating a folder, or deleting a file (something that isn't important, of course!). And as always, if you have any questions, please don't hesitate to contact us.