Skip to main content

RxVantage API Basics

The following are key aspects to understand about the RxVantage API.

Authentication & Authorization​

Accessing the API​

Access to the API is secured through Authorization and requires a JWT (JSON Web Token) to be passed in the request headers. Each request must include the token in the Authorization header using the Bearer Token format.

You can obtain a JWT Token via 2 methods.

The RxVantage API requires authentication:

  1. Machine Authentication
  2. User Authentication

API Credentials​

Each authentication method will require a ClientID and Client Secret. To obtain your ClientID and ClientSecret please contact RxVantage. TODO fill out request form

API Endpoint Header Format​

Include the following header in your API requests:

Authorization: Bearer <your-jwt-token>

API Specification​

The full RxVantage API specification can be found at API Specifications.