Welcome to the RxUtility API documentation! This API has been designed to provide developers easy access to a wide range of medication coupons, helping users save money on their prescriptions. By integrating our API, you can offer your users real-time, updated discounts on the medicines they need.
How to Use
-
1. Obtain Your API Key
To use the RxUtility API, you need an API key. You can request an API key by filling out the contact form.
-
2. Base URL
API requests use the following base URL: https://gateway-staging.rxutility.com/api. Any API endpoints will be subpaths from that base URL.
-
3. Authentication
Pass your API key in an
Authorization: Bearer <api-key>header. When using the "Try It" feature on these docs, enter the full valueBearer <api-key>(including the word Bearer) in the Authorization field.
4. Making Requests
-
5. Handling Responses
The API endpoints will return a HTTP 200, 401, or 500 response code.
A 200 indicates a valid request/response, 401 indicates an invalid or missing gateway credential, and 500 indicates a server issue.
Every API endpoint returns a response in JSON format. The resulting JSON format will differ per API endpoint.
The API is organized in a "RESTful" like pattern. For example, to get the coupons available by the medication's
brand name you may use the endpoint /coupons/{brand_name} and to access coupons by NDC you may use the endpoint /coupons/ndc/{ndc}.