Authentication

All requests to HoldingsIQ must contain the following API key header field:

x-api-key {Unique API key as a string}

You also need to specify the library's EBSCO Customer ID for every HoldingsIQ request. The EBSCO Customer ID is specified as a path parameter and must be specified as described below:

custid {EBSCO Customer ID as a string}

Environments

Sandbox Environment

GET https://sandbox.ebsco.io/rm/rmaccounts/{custid}/...

Production Environment

GET https://api.ebsco.io/rm/rmaccounts/{custid}/...

πŸ“˜

Please Note: Your production API key will not give you access to our sandbox. You will need a sandbox API key to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.

Request Authentication Information

In order to have access to HoldingsIQ, we require you to have both an API Key and an EBSCO customer ID. Access to HoldingsIQ requires a subscription. Please reach out to your sales rep or through EBSCO Connect to learn more about what a HoldingsIQ subscription can do for your institution. The API Key is used for identification. A request for more information on obtaining a production API key can be made from the EBSCO Developer Network portal. Please have your customer follow the instructions below in order to obtain additional information about the credentials that you need to access HoldingsIQ.

To Request API Key Information:

  1. Navigate to the Request Key Information page.
  2. Enter the requested information into the Request API Key Information form fields. The information below is required to ensure that EBSCO can contact someone responsible for the application if necessary.
  1. Click the Request Information button after completing the form. The information is submitted to EBSCO. An email will be sent to you with information about obtaining an API key. Please note that your production API key will not give you access to our sandbox. You will need a sandbox API key to gain access to the API through our interactive documentation or to use the sandbox directly. If you require a sandbox API key, please contact EBSCO customer support.