Getting Started with RxVantage API
The RxVantage API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
You can use the RxVantage API in test mode, which doesn’t affect your live data. The API key you use to authenticate the request determines whether you have access to particular set of endpoints.
A full set of API endpoints can be found at RxVantange API Specification.
Before we get started, there are a few key concepts to understand.
Authentication Methods.
RxVantage endpoints expect you to first authorize against RxVantage API. You can authorize in two different ways:
Each endpoint is set up to support receiving either a machine or user JWT token. Endpoints are configured for the particular JWT token type. For example, routes starting with /machine expect machine JWT tokens. Similarly routes starting with /user expect a user JWT token.
Depending on the type of endpoint you may try to invoke, your first will need to request the correct JWT token from RxVantage. The process is slightly different depending on the endpoint you are trying to integrate with.
Its very important to use the correct token when calling the RxVantage API. If you call an endpoint with the incorrect token, you will receive a 403 Unauthorized response.