Getting Started with the Knowledge Services

Get started with our Knowledge Services here. Learn about our authentication, environment and response codes. Follow a step by step process in order to learn how to use our services.

Authentication

HoldingsIQ and ResourceIQ

All requests to HoldingsIQ and ResourceIQ 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 or ResourceIQ 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}

Please Note: If you have an valid subscription to HoldingsIQ and ResourceIQ, the same APIKEY can be used to access the two products. Your production API key will not give you access to our sandbox. Therefore, your production API key will not give you access to the API through our interactive documentation. 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.

Sandbox Environment

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

Production Environment

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

Please be sure to include the API Key and EBSCO Customer ID with every HoldingsIQ or ResourceIQ request. If you are a commercial library automation systems partner that is developing solutions for multiple libraries, each of these libraries will have their own EBSCO Customer ID and each will be assigned their own API key.

LinkIQ Service

All requests to the LinkIQ service must contain a valid customer profile. The EBSCO customer profile is specified as a path parameter and must be specified as described below:

profile {Unique customer profile as a string in the form of customerid.groupid.profileid}

Sandbox Environment

    https://sandbox.ebsco.io/ftf/ftfaccount/{profile}/...

Production Environment

    https://api.ebsco.io/ftf/ftfaccount/{profile}/...

Please be sure to include a valid customer profile with every LinkIQ request.