Use the API Reference

Our interactive API reference allows you to try our services. For each resource, the interactive documentation provides you with the following:

• URL
• Description
• Parameter list
• Ability to try each resource with different parameters
• Ability to see the response to a specified request

Interact with the resources and see the responses that you can expect back from the API.  The resources are divided into categories.

To Use the Interactive API Reference:

1. Navigate to the MEDSAPI Consumer Health API Reference.  
2. Click on the POST /token resource to expand the resource. The /token resource provides an authorization token.

   Note:  You will need an authorization token from the /token resource to try any of the other resources in the MEDSAPI Consumer Health API Reference.

3. Click the Try it out button within the expanded /token resource.
4. Replace the {client id} and {client secret} in the body Example Value with your clientid and clientsecret.  If you require additional body parameters in your token request, please list them in the body.
5. Click the Execute button.  The interface makes a request to the /token endpoint with your desired body parameters.  A successful Response body is displayed.
6. Copy the access_token value from the /token request Response body.
   
7. Scroll to the top of the page.
8. Click the Authorize button. 
   
9. Paste the access_token that you copied in Step 6 into the Value field of the pop up window.
   
10. Click the Authorize button in the pop up window.  Now, you will be able to use the Try it out button on every resource listed without having to gather the token again.
11. Click the Return to Documentation button in the pop up window.
12. Click your desired resource.  The details for the resource unfold below the resource URL.  A description, successful response format and parameters are listed.

13. Click the Try it out button.

14. Enter the parameters that you would like to try in the Description column.  You must enter a parameter for the fields that are marked required.

    

15. Click the Execute button.  The interface makes a request to MedsAPI Dynamed with your desired parameters.  The Request URL, response code, and response body for your parameters are displayed below the Execute button.