Page History

Purpose

This document is to help you connect your library's Overdrive collection to your Library Simplified circulation manager.

First, you should know that Overdrive provides a glossary that explains most of the terminology.

Getting

...

Access

1. To start connecting your library's Overdrive account to your Library Simplified circulation manager, go to the Member Center and apply for API access. You will need to create an Overdrive developer account.

   Info
   title Overdrive API Types
   Overdrive distinguishes between "Discovery" and "Circulation" APIs. To quote the glossary: Discovery APIs: Discovery APIs are designed to allow your users to browse and explore OverDrive digital collections. You can search for titles, check availability, and get details on specific titles. Circulation APIs: These APIs are designed to allow you to circulate content from an OverDrive digital collection. You can borrow and place holds on titles, see what a specific user has borrowed or placed on hold, and get download links for content that a user has borrowed. Library Simplified uses the Discovery APIs to keep track of the items in your Overdrive collection, and the Circulation APIs to conduct transactions on behalf of your patrons. Library Simplified needs access to both.

2. You'll be asked which API (actually which authentication technique) you want access to. Ask for access to all three. 

   Note
   title Ask for All Three
   You will probably only need two of the three, but the approval process is slow, it doesn't cost anything extra to get all three, and you won't have to go back and re-apply if your authentication situation changes.

   Info
   title Authentication Types
   When the Library Simplified circulation manager makes a call to the Overdrive API, Overdrive needs to verify that the circulation manager is authorized to act on behalf of your library. If the circulation manager is acting on behalf of a specific patron (e.g. creating a loan), Overdrive also needs to know that the circulation manager is authorized to act on behalf of that patron. Overdrive offers three types of authentication: Client authentication verifies that the circulation manager is authorized to act on behalf of the library. It's used by scripts that run in the background to maintain an accurate picture of your library's Overdrive collection. Patron authentication and  Granted authentication  2 and 3 are used when the circulation manager is carrying out the wishes of a specific patron. In all three cases, the goal is to get an access token. An access token is a string that you can present to the Overdrive API to get it to actually do something. An Overdrive access token is generally good for one hour. Once it expires, you need to get a new one.

   Note
   title Apply for Access Early!
   It can take a week or more to get approved for API access, so don't put this off!

3. Under "Planned API usage", mention the name of your library and that you are integrating your Overdrive collection into the SimplyE system.

4. Wait for Overdrive to send you an email with production IDs needed to configure your Circulation Manager Overdrive Collection.  

   Note
   title Sandbox vs Production IDs
   When Overdrive gets back to you, they may give you a website ID of 100300 and a library ID of 4425. Those are the IDs for the Overdrive test library. If this happens to you, go back to them and tell them that you need the production IDs to integrate your library into the SimplyE system.

Configuring Circulation Manager

1. Open a web browser and open your circulation manager admin interface.   This is you circulation manager URL with https://circulation.libraryname-state.org/admin  
2. From the menu bar, click Configuration to enter into the Configuration Manager portion of the Admin interface.
   
3. Select Collections from the menu on the left and select Create a new collection
   
4. Select Overdrive from the Protocol drop down field.
   
5. Fill in the configuration form
   1. Under Name, enter the collection Name (example: “Overdrive”)
   2. Under Parent, enter the Parent Account name if applicable
   3. Under Library ID, enter ID provided by Overdrive
   4. Under Website ID, enter your circ manager URL
   5. Under Client Key, enter key provided by Overdrive
   6. Under Client Secret, enter secret provided by Overdrive
   7. Under ILS Name, enter the name of your ILS
   8. Under Add Library, select the library this collection servers from drop down menu.
   9. Click Submit
      

More about Overdrive Authentication 

...

https://my-circulation-manager.com/oauth_callback?provider=Overdrive

https://oauth.overdrive.com/auth?client_id={ID}&redirect_uri={URLredirectedTo}&scope=accountId:{ID}&response_type=code&state={optionalStateParameter}

https://my-circulation-manager.com/oauth_callback?provider=Overdrive&state={optionalStateParameter}&code={authorizationCode}

Related articles

...