...
The following steps will help you complete the application for to obtain Overdrive API credentials for your library collection. As a precaution, you may wish to whitelist the email addresses associated with the application process so the response emails don't get caught by your spam protection software. At the least, you should whitelist the following two specific addresses:
apisupport@overdrive.com
support@overdrive.com
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 to obtain credentials required in connecting the Circulation Manager to your Overdrive account.
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!
Click the Apply link to start the application.
Complete the Developer Application form as shown below
a. For the "Are you requesting a new API client" dropdown, select the Existing Client option.
b. Enter your name and your email address into the Contact Name and Contact Address fields.
c. If you know your library's Overdrive identifier, you can enter it in the API Client Key field. If you don't, you can enter your library's city and state. The API Client Key should be provided to you in your response from Overdrive for developer access.
d. Be sure to select both the Discovery and the Circulation options in the API Access Requested field.
Info title Overdrive API Types Overdrive distinguishes between Discovery and Circulation APIs. Library Simplified needs access to both, to keep track of the items in your collection as well as to conduct circulation transactions on behalf of your patrons.
From 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.
e. Copy the following block of information in the Planned API Usage field. It is important to request all three authentication types (see the NOTES section below). Be sure to edit your library's name; the remainder of the items should remain as is:
Library: Your Library Name
Project: Integration with SimplyE, in partnership with NYPL
Environment: Production (not testing)
Authentication Types Required:
- Client authentication
- Patron authentication
- Granted authentication
f. Click the Confirm Conditions checkbox.
g. Click the "I am not a robot" checkbox.
h. Once you've reviewed the form, click the Submit button to complete the registration
Wait for Overdrive to send you an email with production IDs needed to configure your Circulation Manager Overdrive Collection. You will receive an email response (to the address you provided above) almost immediately upon submitting your application, which is just a confirmation Overdrive received your request. In about 24 hours so (perhaps longer depending on circumstances) you should receive an email with your library's API credentials. The credentials will include the following data points:
Library ID
Website ID
Client Secret
Library ILS name
OverDrive digital collection URL
If you did not know your exact API Client Key to enter into the application form above, and you don't see it in the response, reply to the support address and request the API Client Key as well.Note title Sandbox vs Production IDs When Overdrive sends your API credentials email, you may accidentally receive 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, reply to the email and tell them that you need the production IDs to integrate your library into the SimplyE system.
...