Making Your First Request

Our interactive API Reference allows you to try the DynaMed/DynaMedex endpoints. It is available to help you to make your first request and test the various parameters. For each endpoint, the interactive documentation provides you with the following:

  • URL
  • Description
  • Parameter list
  • Ability to try each endpoint with different parameters
  • Ability to see the response to a specified request
  • Code samples in several languages. The code samples provided reflect the parameters entered into the reference parameter fields.

Interact with our endpoints and see the responses that you can expect back from DynaMed and DynaMedex. For each endpoint in our API Reference, the description, recent requests, parameters and response variations are displayed under the URL. The code samples and actual response are displayed in the right hand column. Explore the endpoints by following the sequence of steps below. Navigate to the DynaMed and DynaMedex API Reference to begin.

Authentication

  1. Click the Token section in the left-hand menu. The details for the /medsapi-auth/v1/token endpoint are displayed in the middle column.
  2. Click the Base URL drop-down menu in the right-hand column.
  3. Select the /apis.ebsco.com/medsapi-auth/v1 base url.

πŸ“˜

Three choices are provided for the Base URL. Please verify that your Base URL in the right hand column is set to /apis.ebsco.com/medsapi-auth/v1.

  1. Enter client_credentials, dynamed, the EBSCO provided client id and the EBSCO provided client secret for the grant_type, product, client_id, and client_secret fields in the center column.
  2. Click the Try It! button. The API reference makes a request to the API with your desired parameters. The response is displayed in the RESPONSE section to the right.

The access_token field in the /medsapi-auth/v1/token response contains the Bearer token that is needed to access the DynaMed or DynaMedex endpoints.

Searching DynaMed Content

  1. Click the Search section in the left-hand menu.
  2. Click the Base URL drop-down menu in the right-hand menu.
  3. Select the /apis.ebsco.com/medsapi-dynamed base url. The details for the /medsapi-dynamed/v2/content/search endpoint are displayed in the middle column.

πŸ“˜

Please ensure that the Base URL in the right-hand column is set to /apis.ebsco.com/medsapi-dynamed.

  1. Set the Body Parameters. Enter the term to search for in the query field. Add an aggregations array by clicking ADD STRING and selecting the default value. Add a fields array by clicking ADD STRING and selecting "title".

πŸ“˜

Please note that the Bearer field in the righthand column is automatically populated with the Bearer token if you called the /medsapi-auth/v1/token endpoint first.

  1. Click the Try It! button. The API reference makes a request to the API with your desired parameters. The endpoint searches DynaMed articles and media for the query term entered. The response is displayed in the RESPONSE section to the right.