digitool api project
DESCRIPTION
This presentation was given by Alan Manifold at the 2014 ANZREG Seminar in Melbourne, VIC, held at the State Library of Victoria. It gives a quick overview of the creation by staff of the State Library of Victoria of a set of APIs (Application Programming Interface) to access directly the data within the DigiTool system. This allows users to create their own mashups and for the library to fashion a more flexible interface for using digital objects without being tied too closely to a DigiTool syntax and DigiTool viewers.TRANSCRIPT
7 February 2014
Alan ManifoldDigital and Library Applications
Manager
DigiTool API Project
P–2
Project Overview
Create alternate interfaces to imagesFor programmers (in SLV or outside)PrefilteredCopyright statusCultural sensitivity
P–3
DigiTool already has APIs, right?Too complexDifficult to understandEven harder to useNot consistentNot focused the way we need them to beNo filtering
P–4
What new APIs can do
Deliver image file in raw formatNo DigiTool viewerDirect access to parts of complex objectsE.g. individual postcards in a catalogued setAugment DigiTool dataVoyager fieldsPrimo tags and reviews
P–5
Design Goals
Limited set of callsConsistent and simple syntaxProgram will handle all complexityFilter out images as requiredAccess information not in any current API callCombination of calls to DigiTool and Primo
P–6
Let’s See!
P–7
Search
<base_url>/search/<type>/<search>[/numrecs/startrec]http://devel.api.slv.vic.gov.au/search/author/fazzino
<search_results><status>OK</status><error_message></error_message><matching_records>6</matching_records><records>
<record position="1"><record_key>951351</record_key><record_type>simple_image</record_type><record_summary_url>
http://devel.api.slv.vic.gov.au/record_summary/951351
</record_summary_url></record>…
</records><nextrange_url>
http://devel.api.slv.vic.gov.au/search/lygon/20/21</nextrange_url>
</search_results>
P–8
Record Summary
<base_url>/record_summary/<number>
http://devel.api.slv.vic.gov.au/record_summary/951351
<record_summary><record_key>951351</record_key><record_type>simple_image</record_type><image_type>image/jpeg</image_type><record_access_url>
http://devel.api.slv.vic.gov.au/access_record/951351</record_access_url><record_metadata>
<title>No. 52 Lygon Buildings [technical drawing]</title><author>Fazzino, M., draftsperson.</author><date>1979.</date><copyright>
This work is in copyright.Copyright has been assigned to the State Library of
Victoria</copyright>…
</record_metadata></record_summary>
P–9
Access Record
<base_url>/access_record/<number>
http://devel.api.slv.vic.gov.au/access_record/951351