Download presentation
Presentation is loading. Please wait.
Published byLeonard Leonard Modified over 8 years ago
1
Sierra APIs Rebecca Jones, VP of Software Engineering, III Brad Jung, VP of Product Management, III
2
Why APIs?
3
What Have We Been Hearing And Seeing? Image Source: Nielson.com
4
What Do We Hope They Will Do For You? Extend core ILS / LSP to better serve patrons New uses Solve old problems Attract new users Enable you to engage developers Allow you to rapidly prototype
5
Development Model Library Idea Initial Prototype App for Library Use Share with Community Expand App Use Mainstream Feature / App
6
Usage Details Best News: Basic API usage included with your application purchase / subscription S, M, L Usage Commercial Use TBD
7
What We Want To Provide Well Defined APIs Tiered Use Support Developer Community
8
Sierra REST API Strategy API Objectives Research Authentication Syntax
9
Sierra REST API Objectives Maximize developer productivity and success “Industry standard” Consistent, easy to use syntax Extensible Discoverable Manage sophisticated data Small footprint/low server impact
10
Research Google APIs Google Drive Google Picasa YouTube API Craft Google Group Apigee videos and presentations Lots of other resources
11
Authentication Consumer IDs For developers Library manages who has access Grant types OAuth Password Sierra user types Staff (with associated permissions) Patron (permissions only to the patron's info)
12
Record Profiles Maps your specific record data to your app Field selection "title" instead of t245 subfield a and b "publisher" instead of p260 subfield a Named set of fields returned for a record. For example, bib info: “title” “author” “publisher”
13
Partial Response Allows you to bring back only the data you need For the display you only want Bib Info title author publisher holds, for each hold date placed patron name pickup location NOT additional data fields, items, etc
14
Example Request GET /v2/bibs/b11505243?fields=bibinfo,holds
15
Example Response { "key": “b11505243”, “bibinfo": {”title" : [{"value": ” The Big Short: Inside the Doomsday Machine"}], ”author” : [{"value": ” Michael Lewis"}], ”publisher” : [{"value": ” W.W. Norton & Company; 1st Edition (March 15, 2010)"}]}, "holds": { "links": { "self": { "href": ”http://rest.mylib.com/v2/holds" }}, "array": [ { "key": "hold-36”, "links": { "self": { "href": ”http://rest.mylib.com/v2/holds/hold-36" }}, “attributes": { ”pickupAtName": ”Main Library”, ”datePlaced": ” 2013-03-25T10:15:56-08:00”} “patron": { "info": [ ”fullName": [{"value": ” Michael Pollan"}]} }, { "key": "hold-247", "links": { "self": { "href": ”http://rest.mylib.com/v2/holds/hold-247" }}, “attributes": { ”pickupAtName": ” Bookmobile”, ”datePlaced”: ” 2013-03-25T10:56:22-08:00”} “patron": { ”info": [ ”fullName": [{"value": ” Michael Chabon”}}] }
16
Partial Update PUT /v2/holds/hold-36 Update just pickup location code {“attributes": { "pickupLocationCode": ”main”}} Update “not wanted after” date {“attributes”: { ”notWantedAfterDate”: ” 2013-04-01T10:15:56-08:00”}} Or both {“attributes”:{ "pickupLocationCode”: ”main”, “notWantedAfterDate”: ” 2013-04-01T10:15:56-08:00”}}
17
Other Standard Elements Query Parameters ?query=“the big short” Pagination Ability to ask for a reasonable chunk ?Offset = 0 ?Limit = 25 (25 at a time) Links (URIs) for navigation self next previous Response Codes Success Not authenticated Not authorized
18
Consumer Types Java JavaScript PHP Ruby iOS Flash Perl etc
19
Hot Authors at The Public Library of Cincinnati and Hamilton County
20
Developer Community API Definitions Discussions Code Samples Code Sharing “Sandbox” SQL as well
21
Roadmap Winter 2013 Discovery – Read Only Holds Early 2014 Key Circulation Functions Developer Community Summer 2014 Key Tech Services Connections
22
Next steps Cincinnati - we are generalizing the API Looking for other early adopters “We’re listening”
23
Thank You!
Similar presentations
© 2025 SlidePlayer.com. Inc.
All rights reserved.