EDS API now supports API keys, tokens used as unique identifiers. These keys monitor access, isolating traffic by customer and use case. Customers can have multiple API keys to support different client applications or use cases.

📘

Please note that API keys do not replace EDS API's existing authentication or session tokens.

Requesting an API Key

Existing Implementations

You are not yet required to use an API key if your EDS API client implementation was built before the introduction of API keys. You may optionally request an API key and start using it immediately. If you would like an EDS API key, please contact EBSCO to request a key. Upon requesting a key, you may be asked to complete a brief survey to describe your EDS API use case before receiving your key.

New Implementations

If you would like an API key for a new EDS API implementation, please contact EBSCO. Upon requesting a key, you will be asked to complete a brief survey to describe your EDS API use case. Once your request is approved, you will be sent your API key. Your key will have development restrictions in place until EBSCO reviews your complete implementation. Once your EDS API implementation is ready, EBSCO will review your implementation and lift the development restrictions for production use.

Using an API Key

EDS API supports the use of an API Key for authentication transmitted in the request header. To use your API key, add a header named x-api-key to your request. Set x-api-key to the API key value that you received from EBSCO.

x-api-key: YourAPIkey

If you have already been assigned an API key, you must include the API key with every request made to EDS API.