Vecta API

Before continuing, usage of the Vecta API requires an API key. Without this key you will not be able to make requests. Please direct request an API key from a Vecta representative Request API Key

Postman, an API platform for building and using APIs: Postman Homepage

Postman Tutorials Learning Postman

cURL, cURL is a software command-line tool for transferring data using various network protocols. cURL Homepage

It's highly recommended that you read the sections below as they provide the basic information on how to use the API Key, Authentication Token and Versioning. After which opening the documentation at the /api/auth endpoint to generate a token is where it all starts.

View API Documentation

Once you have successfully generated an authentication token you can click the authorise button in the swagger documentation to unlock all the end points.

In order to make requests to the Vecta API you must provide a valid API key. This is sent with all requestests as a custom header X-API-KEY.

Any requests sent without the API key will be returned as a 401(Unauthorized).

Postman example:

The bearer token is required for all endpoints apart from auth. It is a JWT token that can be retrieved via the /auth/ endpoint after a successful authentication request.

The bearer token must be supplied in the header of a request with the prefix bearer.

Postman example:

By default any requests will use the minimum version of a route.

The recommended course of action is to always send the API route version you intend to use.

To accomplish this supply the request header X-API-VERSION with a version number.

Postman example: