Getting Started

Overview

The eVault Portal is the best place to get started! Here you will find Getting Started materials, details guides and walkthroughs, API reference documentation, access to a robust Postman Collection and recipes to get you started with some of the more common workflows used by customers.

Obtaining API Credentials

In order to use the eVault API, you will need a set of API Credentials granting you access to the system. For more information, see Obtaining API Credentials and Authorizing Endpoints.

Making your First Call to the API

Now that you have API Credentials and Postman configured, you are ready to make your first call to the API.

The simplest way to verify that you have authenticated properly is to make a simple GET call to the API.

For example, if you call GET /api/connectivity-check, you should receive back a response that provides basic information about any indicating that the connection worked Here is an example response:

{
    "success": true,
    "errors": null,
    "warnings": null,
    "data": {
        "status": "ok"
    }
}