Streaming Video Search API Integration Guide
Scott Wojtowicz, Last modified by Scott Wojtowicz April 24 2017 10:07 AM
|
|||||||||||||||||||||||||||||||||
With the abundance of electronic resources available today, many schools prefer to access their educational assets in one place. Federated Search Engines and other Discovery Tools allow libraries to do just that - easily browse through multiple content sources in their catalog at the same time.
The Infobase Search API provides a much needed “Communication Bridge” between our content and any Discovery Tool that our mutual customers may be using. Api.infobase.com quickly indexes search results from our Streaming Video Platform in a universal XML format. These customizable XML search results can then be parsed with search results from other outside sources by an Infobase Discovery Tool partner.
In this Search API Integration Guide, you will find everything you need to know to get started as an Infobase Discovery Tool partner.
Available Products
The Infobase Streaming Video Search API is currently available for the following online products:
Search Query
In order to utilize the API, there are certain query parameters that must be added to the URL routing:
Api.infobase.com/msearch/accountID/vendorID/productID/searchterm/format
"
Account ID This is the customer’s Infobase Account ID. If you are using the API to harvest
Vendor ID This is the Discovery Tool Partner ID that will be provided once a connection has been established with Infobase.
Product ID This is the Product ID for what Infobase products you would like to query. Here are the currently available product IDs:
ACADEMIC
Master Academic Collection (Package of the following) - ID 105 FOD: Business & Economics Collection - ID 100 FOD: Health Video Collection - ID 97 FOD: Humanities & Social Sciences Collection - ID 98 FOD: Science & Mathematics Collection - ID 99
Career & Technical Education Collection (Package of the following) - ID 106 FOD: Careers & Job Search Collection - ID 101 FOD: Family & Consumer Sciences Collection - ID 102 FOD: Guidance & Counseling Collection - ID 103 FOD: Technical Education Collection - ID 104
Additional Collections FMG Archival Films & Newsreels Collection - ID 125 FMG World Cinema Collection - ID 196
^Canadian Versions available.
Other & International FOD: United Kingdom - ID 183 FOD: Asia - ID 184 FOD: International Markets - ID 185 FOD: Australia - ID 194
Individual Subject Collections (Sold Separately) FOD: Anthropology - ID 150 FOD: Area Studies - ID 152 FOD: Art & Architecture - ID 153 FOD: Biology - ID 154 FOD: Business & Economics - ID 100 FOD: Careers & Job Search - ID 101 FOD: Communication - ID 157 FOD: Criminal Justice & Law - ID 158 FOD: Earth Science - ID 159 FOD: Education - ID 160 FOD: Engineering - ID 161 FOD: English & Language Arts - ID 162 FOD: Environmental Science - ID 163 FOD: Family & Consumer Sciences - ID 102 FOD: Geography - ID 165 FOD: Guidance & Counseling - ID 103 FOD: Health & Medicine - ID 167 FOD: History - ID 168 FOD: Mathematics - ID 169 FOD: Music & Dance - ID 170 FOD: Philosophy & Religion - ID 171 FOD: Nursing - ID 186 FOD: Physical Science - ID 172 FOD: Political Science - ID 173 FOD: Psychology - ID 174 FOD: Sociology - ID 175 FOD: Technical & Trade Education - ID 176 FOD: Technology & Society - ID 177 FOD: World Languages - ID 178 FOD: Veterinary Science & Technology - ID 214 FOD: Physical Therapy - ID 215
K-12
Classroom Video On Demand - ID 121 CVOD: Career & Technical Education Video Collection - ID 124
^Canadian Versions available.
Curriculum Video On Demand: Australia - ID 189
Additional Collections FMG Archival Films & Newsreels Collection - ID 125 FMG World Cinema Collection - ID 196
Learn360 - ID 136 Learn360 Canada - ID 143 Learn360 International - ID 187 Learn360 Feature Film Collection (Criterion On Demand) - ID 145
Public Library
Access Video On Demand (Package) - ID 107 AVOD: Health & Wellness - ID 108 AVOD: Science, Mathematics & Technology - ID 109 AVOD: Business & Economics - ID 110 AVOD: Arts & Humanities - ID 111 AVOD: Social Sciences - ID 112 AVOD: Careers & Trades - ID 113 AVOD: Home & Family - ID 114 AVOD: Travel & Recreation - ID 115 AVOD: Film & Television - ID 180
^Canadian Versions available.
AVOD: Australia - ID 193 AVOD: International Markets - ID 195
Additional Collections FMG Archival Films & Newsreels Collection - ID 125 FMG World Cinema Collection - ID 196
Search Term This is the
For example, "Dogs+AND+Cats" / "Dogs+OR+Cats".
Format This is the desired output format you would like the results to be returned in. The available formats are:
Search Results
After you have submitted a search query to the API,
Please note: The Account ID in the Record URL will match the Account ID provided in the original Search Query. Using a customer’s correct account ID is the only way for any authentication settings and usage statistics recording to work properly.
Non-video asset types are now supported as well. Learn360 queries will include Images, Printables, Articles, Audio, and Interactives.
Sample Search
Here is an example of a Search Query for the term “frogs”:
http://api.infobase.com/msearch/0/0/0/frogs/xml
The Account ID and Vendor ID have been set to 0 for this example.
Once completed, the XML end result would look like this for the first record returned:
<Root xmlns:json="http://james.newtonking.com/projects/json" json:id="1">
Record URL Authentication
It is Discovery Tools partner responsibility to ensure that the customer’s Infobase Account ID is used in the provided Record URLs. When harvesting for meta-data, the Account ID
<RecordURL> http://cvod.infobase.com/PortalPlaylists.aspx?wID=0&xtid=80418 </RecordURL>
Additional Help
If you have any | |||||||||||||||||||||||||||||||||
|