Sierra API Developments AIUG Milton Howard

Transcription

1 Sierra API Developments AIUG 2016 Milton Howard

2 What we ll cover Where we ve been What s New in Sierra API v3 Pricing, Packaging, Distribution Professional Services Innovative Developer Network The Road Ahead Q&A

3 Where we ve been

4 A Brief History Q v1.0 Bibs API (READ) Items API (READ) Q v2.0 Authorities API (READ) Branches API (READ) Patrons API (CRUD on limited fields) Q v2.1 Bibs API Improved MARC record harvesting Patrons API Find by barcode, READ # renewals, READ hold queue length Renew checkout Update PIN Q v2.1.1 Support pack with bug fixes Launched developer forum Q v3.0 Acquisitions API Orders API Search API Info API Improved security Q v3.1 Bibs API Keyword Search Patrons API Access reading history validate barcode/pin Acquisitions API Foreign currency and date format support Q v3.2 Patrons API Full patron CRUD, Part A New functionality is delivered every quarter.

5 API Investment Developers Quality assurance Product Owner

6 What s New in Sierra API v3?

7 Sierra API v3 Releases Sierra API v3.0 (bundled with Sierra 2.3) Sierra API v3.1 (bundled with Sierra 2.4) Sierra API v3.2 (In beta and bundled with Sierra 3.0)

8 Sierra API v3.0

9 Sierra API v3.0 NOTE Requires Sierra 2.3 or above Acquisitions API - Create new acquisitions orders Create Lists Search API - Create Lists" style nonindexed searches on Bibs, Items, Patrons, Orders, and Authorities records Improved security - Finer grain access controls to endpoints Orders API - Read Sierra order records and fund properties Info API - Read API version, patron ID, token ID, auth scheme, auth token expiration, auth token permissions.

10 Acquisitions API

11 egacy Acquisitions Process Library Selects Titles & Enters Pre-Order Details in Vendor System Orders & Bibs Vendor Manual Export MARC EXPORT FTP EDIFACT Orders Sierra Vendor Order Acks Sierra (Match Bibs & Create Orders) Vendor

12 Acquisitions API Summary Description First API to expose financial / acquisitions data, including creation of new order records GOBI is first 3 rd party vendor to consume this new API. Other vendors are in early stages of adoption. Real orders being placed with new API Details 5 New Endpoints for ordering workflow POST /v3/acquisitions/orders (Create a new order) POST /v3/acquisitions/orders/validate (Validate order data) GET /v3/orders (Read a list of orders) GET /v3/orders/{id} (Read an order by record ID) GET /v3/orders/funds/{acctunit}/{fundcodenum} (Read the properties of a given fund) Loads order and bib info according to m2btab.oapi load profile. m2btab.oapi load profile provided.

13 New Modern Process with Acquisitions API Library Selects Titles & Enters Order Details in GOBI Orders & Bibs YBP.o order number automatically sent via API Sierra Sierra (Use Load Profile to Match Bibs & Create Orders)

14 Acquisitions Walkthrough

15 Example New GOBI Order Process Santa Clara University

16 GOBI Order Using GOBI, library selects title, enters order details, and submits order (to Sierra).

17 GOBI Open Order Seconds later Open order available in GOBI.

18 Sierra Bibliographic Record Seconds later Ordered bib as seen through Sierra Desktop Administration.

19 Sierra Order Record Seconds later Order record as seen through Sierra Desktop Administration.

20 OPAC View Seconds later Order as seen through Santa Clara University OPAC.

21 Growing Customer List Orders Flowing Langara College (Canada) Massey University (New Zealand) Michigan State University Santa Clara University San Jacinto College University of Wyoming Implementing Appalachian State University Occidental College Texas A&M University (Qatar campus) University of Akron Virginia Tech Weill Cornell Medical College (Qatar campus)

22 Vendor Pipeline Askews (UK) Baker & Taylor Bookfarm Bound to Stay Bound Brodart Coutts (UK) Dawson (UK) Harrassowitz Ingram LBI (Canada) Library Bound (Canada) Midwest Library Service Midwest Tape O'Mahoney's (Ireland) Quality Books SAPnet (South Africa) ULS (Canada) White Hots (Canada) YBP (First to implement)

23 Create Lists Search API

24 Create Lists Search API Summary Description Execute Create Lists style search queries Details POST /v3/bibs/query, /v3/items/query, /v3/patrons/query, /v3/authorities/query, and /v3/orders/query Uses Create Lists JSON schema for queries Synchronous search (results returned on the fly, not in a review file). Direct support for 3 rd party / hot authors / authentication and other search use cases Capturing results in review file planned in future release.

25 Example Queries (JSON output from Create Lists within SDA) Titles matching Moby Dick { } "target": { "record": {"type": "bib"}, "field": {"tag": "t"} }, "expr": { "op": "has", "operands": ["moby dick"] } Titles matching Moby Dick and author Melville. { "queries": [ { "target": { "record": {"type": "bib"}, "field": {"tag": "t"} }, "expr": { "op": "has", "operands": ["moby dick"] } }, "and, { "target": { "record": {"type": "bib"}, "field": {"tag": "a"} }, "expr": { "op": "has", "operands": [ Melville"] } } ] } { } Patrons that expire on or after date "queries": [ { "target": { "record": { "type": "patron" }, "id": 43 }, "expr": [ { "op": "greater_than_or_equal", "operands": [ " ] } ] } ]

26 Security Enhancements

27 Security Enhancements Summary Description Better security available to lock down API endpoints Each endpoint group (e.g., Bibs, Items, Patrons, Orders, etc) can be assigned no access, read access, and/or write access. Details New Sierra Admin module to support finer grain security controls over endpoint groups.

28 Security Enhancements NewAPI Key Controls Old API Key Controls

29 Sierra API v3.1

30 Sierra API v3.1 NOTE Requires Sierra 2.4 or above Keyword Search API - Perform keyword searches using Innovative's "RightResult" relevance ranking algorithm. Enhanced Patron API Reading History - Access patron reading history if patron has opted in. PIN Validation Verify a patron s barcode and PIN. Replaces legacy Patron API (URL) PIN test. Enhanced Acquisitions API - Converts dates and orders placed in a foreign currency with a vendor to the library s native date and currency formats.

31 Keyword Search API

32 Keyword Search API Summary Description Execute keyword based searches for bibs using Advanced Word Search (AWS) segments. Details POST /v3/bibs/search Synchronous search -- results returned on the fly along with relevance ranking. Uses Advanced Word Search (AWS) Segments Examples: rightresultexact, rightresulttitle, rightresultfull, isbn, etc Example Query POST /v3/bibs/search?limit=10&index=rightresultfull&text=harry Potter

33 Example Search Results { "count": 10, "total": 112, "start": 0, "entries": [ { "relevance": , "bib": { "id": " ", "updateddate": " T23:23:29Z", "title": "Harry Potter and the prisoner of Azkaban, etc }

34 Patron API - Reading History

35 Patron API - Reading History Summary Description Access patron reading history if patron has opted in. Details GET /v3/patrons/{id}/checkouts/history Read list of patron bibs that have been previously checked out. Patron can opt-in or out through WebPac Example Query GET/v3/patrons/ /checkouts

36 Example Reading History Results { "total": 8, "entries": [ { "id": " "patron": " "item": " "duedate": " ", "numberofrenewals": 0, "outdate": " T11:58:02Z" }, etc...

37 Patron API PIN Validation

38 Patron API PIN Validation Summary Description Validate a patron s barcode and PIN. Details POST /v3/patrons/validate Alternative authentication method to OAuth2 auth code grant flow for patrons and legacy Patron API (URL) PIN test. Example Query POST /v3/patrons/validate HTTP Body { barcode : , pin : mypin }

39 Example PIN Validation Results Success Valid barcode and PIN HTTP Response Code 204 Error Invalid barcode and PIN HTTP Response Code 400 { "code": 108, "specificcode": 0, "httpstatus": 400, "name": "Invalid parameter", "description": "Invalid parameter : Invalid barcode or PIN" }

40 Example Use Cases

41 Example Use Cases 3 rd party discovery People-also-Read Auto Renewal for patrons Hot Authors / Auto Holds SMS/ Notifications Expiring library card Due date nearing Deduping barcodes

42 Pricing & Packaging

43 Pricing & Packaging Still FREE to the Library Bundled and distributed with Sierra 2.3+

44 Professional Services

45 Professional Services Acquisitions API is FREE to the Library but in some cases, sites will need services to customize the default load profile for orders and bibs. Load Profile Service: [H][NH]-Q-PS_DATA_PROFILE, $2,900 Custom Development Services

46 Developer Sandbox & Portal

47 Developer Sandbox Hosted Sierra 2.x server Latest API software Pre-loaded with data Develop & QA code Register at developer.iii.com and follow Getting Started.

48 Growing Developer Community Documentation links Link to sandbox Online discussion forums Collaborate and share ideas and code 300+ registered users to date on developer.iii.com

49 The Road Ahead

50 Key Enterprise System Focus Areas Student Information System Integration Facilitated by full patron CRUD Accounting System Integration Facilitated by a collection of APIs that enables sharing of invoices, orders, and fine information between accounting systems and Sierra

51 Full Patron CRUD Summary Description Full CRUD on patron records Part A included with next Sierra Beta 3.0 bundle Details POST /v3/patrons, GET /v3/patrons, PUT /v3/patrons, DELETE /v3/patrons First release supports CRUD on patron record names, addresses, s, phones, and PINs. Next release: barcodes, expirationdate, birthdate, patrontype, universityid, other fixedfields and varfields Example request to create a patron POST /v3/patrons HTTP Body: { "names": [ "Test Howard" ], " s": [ "test@gmail.com" ], "addresses": [{ "lines": [ "5 Davey St", "Hobart, Tasmania 7000", "Australia" ], "type": "a"}], "phones": [ { "number": " ", "type": "t" } ] }

52 Example Patron CRUD Results { "link": } HTTP Response Code: 200

53 Accounting API - Preliminary Summary Description Collection of APIs that enables sharing of invoices, orders, and fine information between accounting systems and Sierra Details CRUD on invoices Create an invoice Get a list of invoices Update an invoice Delete an invoice CRUD on vendor record Create a vendor record Get a list of vendor records Update a vendor record Delete a vendor record CRUD on patron fines Create a fine for a patron Get a list of fines for a patron (available now) Get a fine record by fine ID (available now) Update a fine for a patron Delete a fine for a patron Acquisitions API (available now) Orders API (available now)

54 Q & A

55 Thank You!