The world’s libraries. Connected.
WorldCat knowledge base API Workshop
29 October 2013
Shelley Hostetler, Community Manager WorldShare Platform
Paul Moss, Product Manager
Jeff Carter
Brian Cassidy
The world’s libraries. Connected.
• Covering functionality, use cases, demonstrations, and discussion
1. WorldCat Metadata API Workshop - recording available on Developer Network http://oc.lc/metadata-api-workshop
2. WorldCat knowledge base API
3. Coming soon! Stay tuned to http://www.oclc.org/developer/news
OCLC Developer Network API Workshops
The world’s libraries. Connected.
• Describe the WorldCat knowledge base and explain how
the API can add value to your library
• See a live application to get ideas for implementing your
own application
Workshop Goals
The world’s libraries. Connected.
Agenda
• Eligibility • API overview • Use Cases • App demonstration and
code walkthrough • Q & A
The world’s libraries. Connected.
• Anyone can request sandbox access to this web service
• Libraries that participate in WorldCat.org through their Cataloging and FirstSearch subscriptions have access to the API
• Access to the Worldcat knowledge base is included in your Cataloging or CatExpress subscription
• Partners interested in licensing data or a web service • Visit http://www.oclc.org/en-US/partnerships.html
• Contact OCLC Business Development at [email protected]
Who can use this API
The world’s libraries. Connected.
Overview and Use Cases
The world’s libraries. Connected.
• A knowledge base is a set of data about electronic journals and ebooks
• It is used primarily to direct users of a library to the places where they can read full text content
• It is traditionally used as a part of a link resolver, such as • Serials Solutions 360Link
• Ex Libris’ SFX
• OCLC Link Resolver (part of WMS License Manager)
“knowledge base”
The world’s libraries. Connected.
• OpenURL API – Loosely follows the OpenURL conventions for passing citation metadata. Each query contains the citation for an article, book, journal, video, etc. The response will include all records for this library with links to the content.
• REST API – Enables basic title level searching and browsing for Providers, Collections, Entries (titles). Can be used to create an A to Z listing or searching interface.
API endpoints
The world’s libraries. Connected.
Use Case – Integrated Linking
Provided by the KB API
The world’s libraries. Connected.
How does this work?
Step 1: Gather citation metadata
Article Citation
The world’s libraries. Connected.
How does this work?
Step 2: Call the OpenURL API
Article Citation
http://worldcat.org/webservices/kb/openurl/resolve?svc_id=json &rft.institution_id=112877 &rft.spage=376 &rft.title=%22Nature.%22 &rft.content=fulltext &rft.volume=406 &rft.oclcnum=47076528 &rft.aulast=Coles &rft.date=2000 &rft.issn=0028-0836 &rft.issue=6794 &rft.atitle=Characterizing+the+nonlinear+growth+of+large-scale+structure+in+the+Universe &rfr_id=info/sid:oclc.org/WCL &rft.order_by=preference
The world’s libraries. Connected.
How does this work?
Step 3: Parse response (edited) & display {
uid: "612954", issn: "0028-0836", title: "Nature", linkerurl: "
http://link.worldcat.org/?rft.institution_id=112877&spage=376&pkgName=sch&rft.oclcnum=47076528&issn=0028-0836&linkclass=to_article&jKey=NAE&issue=6794&provider=EBSCOhost&date=2000&aulast=Coles&atitle=Characterizing+the+nonlinear+growth+of+large-scale+structure+in+the+Universe&title=Nature&rft.content=fulltext&linkScheme=ebscoh&jHome=http%3A%2F%2Fsearch.ebscohost.com%2Fdirect.asp%3Fdb%3Dsch%26jid%3DNAE%26scope%3Dsite%26site%3Dehost&volume=406&dbKey=sch&rfr_id=info%2Fsid%3Aoclc.org%2FWCL&rft.order_by=preference&localstem=http%3A%2F%2Fsanfrancisco.idm.oclc.org%2Flogin%3Furl%3D&linktype=best",
source: "holdings", coverage_enum: "fulltext indexed", coverage: "fulltext@1997-06-05~P12M indexed@1997-06-05", collection_uid: "EBSCOhost.sch", provider_name: "EBSCOhost"
}
The world’s libraries. Connected.
Use Case – A to Z list
The world’s libraries. Connected.
How does this work?
http://worldcat.org/webservices/kb/rest/entries/search? search-type=atoz &alt=json &max-results=10 &start-index=1 &institution_id=112877 &title=%22A*%22 &content=fulltext,print
Step 1: Call the REST API
The world’s libraries. Connected.
How does this work?
{ title: "WorldCat KnowledgeBase Search: "A*" ", updated: "2013-10-28T15:33:09.924Z", id: "urn:uuid:c06561ea1235962677d47542aabc4d7b", author: "OCLC", links: [ {
href: "http://worldcat.org/webservices/kb/rest/entries/search?content=print%2Cfulltext&search-type=atoz&title=Aa*&scope=my&startIndex=1&orderBy=title+asc&institution_id=112877&itemsPerPage=10",
rel: "atoz", title: "Aa*", length: 30
},
{ href: "
http://worldcat.org/webservices/kb/rest/entries/search?content=print%2Cfulltext&search-type=atoz&title=Ab*&scope=my&startIndex=1&orderBy=title+asc&institution_id=112877&itemsPerPage=10",
rel: "atoz", title: "Ab*", length: 86
},
Step 2: Parse Response & display
The world’s libraries. Connected.
How does this work?
{ title: "A|Z ITU Journal of the Faculty of Architecture", id: "http://worldcat.org/webservices/kb/rest/entries/DOAJ.Records,9230622", links: [ { href: "http://worldcat.org/webservices/kb/rest/entries/DOAJ.Records,9230622.html",
rel: "alternate”}, { href: "http://worldcat.org/webservices/kb/rest/entries/DOAJ.Records,9230622", rel: "self”}, { href: "http://www.az.itu.edu.tr", rel: "via” }, { href: "http://www.az.itu.edu.tr", rel: "canonical” }
], kb:entry_uid: "9230622", kb:entry_status: "raw", kb:collection_uid: "DOAJ.Records", kb:collection_name: "Directory of Open Access Journals (All titles)", kb:provider_uid: "DOAJ", kb:provider_name: "Directory of Open Access Journals", kb:issn: "1303-7005", kb:publisher: "Istanbul Technical University", kb:coverage: "fulltext@2007", kb:coverage_enum: "fulltext”
}
Step 2: Parse Response & display
The world’s libraries. Connected.
Other possible uses
• Display an A to Z list of Collections or Providers
• Display an A to Z list of ebooks/videos/audio
• Navigate between Provider -> Collection(s) -> Titles
• Download a KBART title list for a collection
• Show all available coverage ranges for a journal
WorldCat knowledge base API: eResources Discovery at UNB Libraries
Jeff Carter and Brian Cassidy
Play Along
h+p://lib.unb.ca/eresources/
Journals & Newspapers
OCLC is providing this third party code for demonstra?on purposes and on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limita?on, any warran?es or condi?ons of TITLE, NON-‐INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using the code and assume any associated risks.
OCLC is providing this third party code for demonstra?on purposes and on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limita?on, any warran?es or condi?ons of TITLE, NON-‐INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using the code and assume any associated risks.
e-‐Book Searching
OCLC is providing this third party code for demonstra?on purposes and on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limita?on, any warran?es or condi?ons of TITLE, NON-‐INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using the code and assume any associated risks.
OCLC is providing this third party code for demonstra?on purposes and on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limita?on, any warran?es or condi?ons of TITLE, NON-‐INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using the code and assume any associated risks.
What’s Missing
• mul?ple sort fields – i.e alpha AND kb:collec?on
• greater than 50 results • alpha-‐paging, i.e. Ae, Ab, Ac [Duh!!] • writable REST API
– local holdings collec?on maintenance
• improved applica?on of new format types – video, audio, etc.
The world’s libraries. Connected.
Questions?
The world’s libraries. Connected.
• About the WorldCat knowledge base
• http://www.oclc.org/knowledge-base.en.html
• Web service documentation
• http://oclc.org/developer/services/worldcat-knowledge-base-api
• Assistance
Resources
The world’s libraries. Connected.
• Sign up for a WorldCat.org account
• Request a WSKey in OCLC Service Configuration
• https://worldcat.org/config
• Join the OCLC Developer Network and listserv
• www.oclc.org/developer/register
• http://oc.lc/subscribewc-devnet-l
Get Started
The world’s libraries. Connected.
This Workshop Brought to You By
http://www.oclc.org/developer