Getting Started
The Hoopla team is dedicated to empowering you with effective solutions and timely support, all while looking ahead to collaborative integration advancement. Review the information below to start learning or contact us for further assistance.
Requirements
Minimum system requirements and acceptable uses for the Hoopla partner API.
License to access the API
Unique electronic key to access the API
Library-Specific Display of Hoopla Content Cover Art and Metadata
A library must access the API on a regular basis and promptly update the Licensee Application on a library-by-library basis with all current cover art and identifying information for the content (i.e., title, author, publisher, producer, run-time, copyright notices, etc.) that is available to the library’s users via the Hoopla Service. A library must include with each title record a prominent link to the Hoopla Service, including to the specific title record at issue where the content may be accessed by the Hoopla User.
Search Features and Functionality of Licensee Application
A library must ensure that users are able to electronically search the collection of titles that are available on the Hoopla Service to the authorized patrons of the particular Hoopla Customer with which that user is affiliated. When the catalog allows borrowing of titles, users may electronically borrow and return such titles, but only in accordance with any borrowing restrictions.
Protection of Personal Information of Hoopla Users and Other Individuals
A library must comply with the Hoopla Terms and Conditions of Use and Privacy Policy. Refrain from collecting, storing, using, and/or disclosing to any third party any information regarding Hoopla Users.
Confidentiality and Non-Use of API, Data, and Other Midwest Tape Information
Do not modify or create derivative works of the API or Data. Do not use the API or Data in connection with any product or software beyond the defined scope of use. Do not distribute the API or Data as a stand-alone product. Do not disassemble or reverse-assemble the API or Data without prior written consent. Not sell, lease, share, transfer, or sublicense the API or Data or access or access codes thereto or derive income from the use or provision of the API or Data, whether for direct commercial or monetary gain or otherwise, without Licensor’s prior, express, written permission; Not use the API or Data in a product or service that competes with products or services offered by MidwestTape.
Other Restrictions and Requirements
Licensee shall furnish, at its own expense, any computer, networking, telecommunications and other equipment necessary for Licensee to implement the API, access the Internet, and connect to the Hoopla Service and Hoopla Websites.
The information provided above is detailed in the Hoopla API License Agreement, which must be signed at the point of integration.
Requesting Access
If you’re ready to discuss using our API endpoints, or if you have questions about an existing API integration, let us know! hdiscovery@midwesttape.com
If you currently have access and are reporting an issue or have a question, please provide the following:
- Date and time of occurrence (incl time zone), environment
- Sample of request made, response received, and expected response
- Steps to reproduce (if applicable)
See General Guidelines for Hoopla Partner API Endpoint Use here!
FAQ
What’s the difference between instant and flex titles?
Instant, or PPU, is a pay per use purchase model; available to libraries in the United States, Canada, Australia & New Zealand. Through this purchase model, all Hoopla library partners gain access to a catalog of over 1.8M titles. There is no annual subscription or other fees. The library is only charged for a title if a patron borrows. Once borrowed, the content is available to the user for a set lending period.
“kind”: EBOOK, AUDIOBOOK, COMIC, MUSIC, MOVIE, TELEVISION, BINGEPASS
Lending Periods (variation can exist based on terms of the individual provider agreement)
EBOOK, AUDIOBOOK, COMIC - 21-days
MUSIC - 7-days
MOVIE, TELEVISION - 3-days
Flex, or OCOU/EST, includes the standard purchase model of one copy one user; currently only available to libraries in the United States and Canada. A library may purchase perpetual licenses, time metered licenses, circulation metered licenses or time and circulated metered licenses. A copy is only made available to one user at a time, while subsequent users are placed into a holding queue.
“kind”: EBOOK, AUDIOBOOK
Lending Periods: 21-days (variation can exist based on terms of the individual provider agreement)
Can you explain Hoopla license types and purchase models?
Hoopla license types include instant, or pay-per-use, and flex. Flex includes metered (buy it for a certain timeframe or a certain number of borrows/circulations) and perpetual (buy it once and own it forever).
Hoopla purchase model is the definition of how a library can buy a particular license and what that license allows them to do with the title.
What is a BingePass?
BingePasses are offered as part of the Instant purchase model on Hoopla. When a patron borrows a BingePass on Hoopla, they are given 7-day access. Examples include eMagazines, Curiosity Stream, Hallmark Movies and Hellosauraus, just to name a few. In some cases, users are redirected to the third-party service to consume the content. In other cases, the content is hosted on Hoopla through an exclusive BingePass collection offering.
Formats: Magazines, video, television, games… the possibilities are endless! Note that some BingePasses might contain content that all falls under the same categories, whereas other BingePasses contain a blend of multiple formats.
“kind”: BINGEPASS
Lending Period: 7-days (variation can exist based on terms of the individual provider agreement)
How do I get a library ID for API integration?
When you’re ready to set up the API integration, you can request the library ID from either a Hoopla Specialist or the Product Discovery (PD) Team. Email the PD team at hdiscovery@midwesttape.com.
I'm being told I need log in credentials. What do I do?
If you need an API username and password, this is likely in reference to the discovery layer-specific username and password. The support representative on the vendor side should reach out to the Hoopla Product Discovery team at hdiscovery@midwesttape.com for this information.
If a library is part of a consortium, how do catalog blocks (i.e. price caps, publisher blocks, etc.) work with the API integration?
Oftentimes, discovery layer API integrations allow for 1 library ID to be used for catalog ingestion and 1 library ID to be used for patron title circulation. These library IDs can be the same. If a library is part of a consortium, and the catalog functions as such, the most common execution of this is for the library in the system with the least restrictive catalog settings (very few or no title blocks, no price caps, etc.) to be used for ingestion. Then, each member library can use their own library ID for patron circulation. This means that sometimes a patron will have visibility to a title their particular library cannot circulate, due to price caps, publisher blocks, etc. That being said, they will not be able to check out the title.
A blocked title is still showing as available in the catalog. What do I do?
If there is a block in place – on a title, or a price cap for a certain format – the API sync should register this catalog update and automatically remove title visibility to patrons. If you are still seeing a blocked title as available in the catalog via the discovery layer, this may mean the most recent sync did not run correctly. In this case, the discovery layer support representative will need to be notified, and a case should be submitted through the appropriate support system.