Integration site and environment

OverDrive's integration site is a test digital collection with real digital titles accessible to our API partners. It works just like any OverDrive digital collection you might be developing for but allows you to build your app in our integration environment, without using a live digital collection. With this collection, you can safely test API functionality like borrowing titles, getting user data, searching, getting title metadata, and more.

We may push changes for our APIs to our integration environment before deploying them to production. You can test these staged changes against the integration site to make sure they work with your existing implementation. We'll post on the patch notes and notices page or send an email when there are breaking changes in the integration environment that you should be aware of.

How to test with the integration site

You can use the integration site once you've been approved for API access. To get started, you'll need the following information.

To test Discovery APIs:

• Library ID:
  • For public libraries: 4425
  • For schools: 8450
• Base Discovery API integration URL: https://integration.api.overdrive.com

To test Circulation APIs:

• Website ID:
  • For public libraries: 100300
  • For schools: 203011
• Base Circulation API integration URL: https://integration-patron.api.overdrive.com

To test the Reporting API (public libraries only):

• Website ID: 100300
• Base Reporting API integration URL: https://integration-reports.api.overdrive.com

To test with our front-end site (for example, to test that checkouts fulfilled through the APIs also appear on the site):

• OverDrive library websites (the preferred browser experience for public libraries): overdriveapi.overdrive.com
• Libby (for public libraries): https://libbyapp.com/library/overdriveapi
• Sora (for schools): https://soraapp.com/library/apidemok12

How to authenticate with the integration site

To build your application against our integration site, you can:

• Request one or more test users for the default OverDrive authenticator
• Set up your own test connection on the integration site

Our support team can help you get set up.

Once you're set up and have your client key and secret, you can create a POST request to get an OAuth access token. All POSTs use the same URL for both the integration and production environments.

• URL for client authentication (used for Discovery APIs and the Reporting API): https://oauth.overdrive.com/token
• URL for patron authentication (used for Circulation APIs): https://oauth-patron.overdrive.com/patrontoken

Read more about client authentication and patron authentication in our documentation.