Learn about OverDrive APIs and how they can benefit search, discovery and reporting services at your library. Contact:

Size: px

Start display at page:

Download "Learn about OverDrive APIs and how they can benefit search, discovery and reporting services at your library. Contact: training@overdrive."

Bruce Day
8 years ago
Views:

v.10012010 v.10042013 v.11012010 OverDrive, Inc.

1 v v v OverDrive, Inc Page 1 1 OverDrive APIs Learn about OverDrive APIs and how they can benefit search, discovery and reporting services at your library. Contact: training@overdrive.com

2 Agenda 1. What are APIs? 2. OverDrive APIs 3. API Support 4. Contact us v OverDrive, Inc Page 2

3 What are APIs? APIs (Application Programming Interfaces) are a set of programming instructions for accessing a web-based software application. Allows approved developers to deeply integrate OverDrive-hosted catalogs and nearly 1 million digital titles with their apps and platforms. OverDrive API Design OverDrive APIs are RESTful and utilize Hypermedia links to create construction-free URLs. These are modern development techniques which reduce work for developers. v OverDrive, Inc Page 3

4 Where can developers find OverDrive APIs? The OverDrive Developer Portal Online gateway for developers What's included: 1. Documentation 2. Real world examples 3. Support information 4. Member Center v OverDrive, Inc Page 4

5 Library/Retail Account API Retrieves a link for titles in a library's digital collection, along with general information about the account. The Library/Retail Account API might be accessed to Display available formats List OverDrive Advantage collections List all available titles in a library/retailer collection Serve as a starting point for the Search API v OverDrive, Inc Page 5

6 Search API Delivers a list of titles based on a query. The Search API might be accessed to Retrieve a subset of an OverDrive digital collection Set number of results to display Limit results by format Sort results v OverDrive, Inc Page 6

7 Metadata API Retrieves detailed information for a title: Author, genre, description, reviews and more. The Metadata API might be accessed to Display specific details about a title within an application. Generate a custom collection list based on a field, such as New York Times reviewed titles. Note: Not all titles have metadata associated with every field. v OverDrive, Inc Page 7

8 Library Availability API Retrieves availability information for a title including copies owned, available copies, and holds. The Library Availability API might be accessed to Enable an application to display what s available without a user having to visit a digital library site. v OverDrive, Inc Page 8

9 Patron Information API Gives user-specific information for a single user. This provides hypermedia links to the checkouts and holds endpoints. The Patron Information API might be accessed to Search for and check availability against the titles to which a specific user has access. v OverDrive, Inc Page 9

10 Holds API Manages and places holds for a specific patron. The Holds API might be accessed to Retrieve a list of a user s holds Place a hold on a user s behalf Remove an existing hold v OverDrive, Inc Page 10

11 Checkouts API Allows borrowing, returning, and checking status of titles. The Checkouts API might be accessed to Retrieve a list of a user s borrowed titles Borrow a title on a user s behalf Return a book that has not yet been locked into a format Access the Downloads API for borrowed titles v OverDrive, Inc Page 11

12 Download API Requests the title download from our fulfillment servers by way of a contentlink. The Download API might be accessed to Deliver an ACSM file for an ebook Deliver an ODM file for audiobooks, music and video Note: The Download API cannot filter formats by detecting a user s device; if you d like to add format filtering you ll need to do so within your app. v OverDrive, Inc Page 12

13 API Support Questions about OverDrive APIs? 1. Check our documentation Getting Started API Design API Security API Usage Requirements Real World Examples OverDrive Formats 2. Unable to find an answer, contact us: developer.overdrive.com/support v OverDrive, Inc Page 13

Contact us Collection Development: collectionteam@overdrive.com Training: training@overdrive.

com Support for library staff: Marketplace > Support tab Support for users: Users should

14 Contact us Collection Development: Training: Library Partner Services: Support for library staff: Marketplace > Support tab Support for users: Users should contact Support via the link on the main Help page of your OverDrive library website. v OverDrive, Inc Page 14

Best Practices. for Library Partners to maximize digital circulation. Your checklist to a successful digital collection.

Best Practices. for Library Partners to maximize digital circulation. Your checklist to a successful digital collection. Best Practices for Library Partners to maximize digital circulation Your checklist to a successful digital collection. 1 OverDrive s Best Practices With your OverDrive service, we help you maximize the