API de la Biblioteca
Koldo Mitxelena proporciona acceso a los datos de los libros almacenados en su biblioteca a traves de un API (Application Programming Interface) de tipo REST. Este documento describe la funcionalidad ofrecida y espera servir de ayuda a los programadores que construyan sus herramientas de acceso a la información de la biblioteca.
Contenidos
Acceso a la ficha de un recurso
Devuelve los datos de un recurso (libro u otro objeto catalogado)
URL: http://liburutegia.gipuzkoa.net/api/rest/1.0/book/referencia.xml
Método HTTP: GET
Resultado: Datos del recurso siguiendo la notación Dublin Core.
Ejemplo XML
curl http://liburutegia.gipuzkoa.net/api/rest/1.0/book/000000594191.xml
<?xml version="1.0" encoding="utf-8" ?> <book xmlns:dc="http://purl.org/dc/elements/1.1/"> <dc:identifier>(KM)AMICUS:000000594191</dc:identifier> <dc:identifier>ISBN:978-84-8152-360-7</dc:identifier> <dc:identifier>CDU:913 ESP</dc:identifier> <dc:title>Guía oficial de campings de España</dc:title> <dc:description>Tít. tomado de la cub Índices </dc:description> <dc:type>book</dc:type> <dc:coverage type="spatial">España</dc:coverage> <dc:language>eng</dc:language> <dc:language>eng</dc:language> <dc:language>fre</dc:language> <dc:language>ger</dc:language> <dc:format>526 p., [2] p. de mapas mapas 24 cm +</dc:format> <dc:publisher>[Madrid]. Turespaña</dc:publisher> <library_urls> <url name="Koldo Mitxelena"> <![CDATA[ http://www4.gipuzkoa.net/KMKatalogoa/default.aspx?hreciid=|library%2Fmarc%2Famicus|000000594191 ]]> </url> </library_urls> <dc:rights></dc:rights> <dc:source></dc:source> <dc:date>2009</dc:date> <dc:relation type="marc:777">Guía oficial de campings de España. (KM)594192</dc:relation> <dc:relation type="marc:777">Mapa de campings y carreteras de España]. (KM)594533</dc:relation> <dc:subject type="marc:650">Camping</dc:subject> </book>
Búsqueda de recursos
Devuelve la lista de recursos que coincide con unos criterios de búsqueda.
URL: http://liburutegia.gipuzkoa.net/api/rest/1.0/books.formato
formato = xml, rss, js, json, html
Método HTTP: GET
Parámetros:
- q: Opcional. Término genérico de búsqueda. Ej: http://liburutegia.gipuzkoa.net/api/rest/1.0/books.xml?q=fundacion
- author: Opcional. Nombre del autor.
- title: Opcional. Título del recurso
- isbn: Opcional. ISBN del recurso
- keywords: Opcional. Temas sobre el recurso. Ej: http://liburutegia.gipuzkoa.net/api/rest/1.0/books.xml?keywords=beasain
Resultado: Listado de recursos que se han encontrado.
Ejemplo XML
curl "http://liburutegia.gipuzkoa.net/api/rest/1.0/books.xml?q=fundacion"
<?xml version="1.0" encoding="utf-8" ?> <books> <book> <reference>000000432888</reference> <title>Aena</title> <subtitle>Arte garaikideko bilduma : [Artearen Kutxaguneko Kubo Aretoan] = Colección de arte contemporáneo : [Sala Kubo-Kutxaespacio del Arte]</subtitle> <authors> <author>Fundación Kutxa</author> </authors> <summary>Textos en euskera, castellano, francés e inglés</summary> <cdu>7</cdu> <year>2002</year> <series>Colección Kubo-Kutxa ;</series> <subject> <keyword>arte</keyword> <keyword>exposiciones</keyword> <keyword>fundación aena</keyword> <keyword>s. xx</keyword> <keyword>colecciones de arte</keyword> <keyword>exposiciones</keyword> </subject> <terms_found> <keyword score="4">fundación</keyword> </terms_found> </book> </books>
Objetos devueltos
Listado de recursos
Lista o array formado por objetos con los siguientes atributos:
-
reference: Identificador del recurso.
- Ejemplo: 000000432888
-
title: Título del recurso.
- Ejemplo: Aena
-
subtitle: Subtitulo del recurso.
- Ejemplo: Arte garaikideko bilduma : [Artearen Kutxaguneko Kubo Aretoan] = Colección de arte contemporáneo : [Sala Kubo-Kutxaespacio del Arte]
-
authors: Listado de autores.
- Ejemplo: Fundación Kutxa
-
summary: Comentarios sobre el recurso.
- Ejemplo: Textos en euskera, castellano, francés e inglés
-
CDU: Signatura del recurso.
- Ejemplo: 7.036 FUN AEN
-
year: Año de publicación.
- Ejemplo: 2002
-
series: Grupo al que pertenece el recurso.
- Ejemplo: Colección Kubo-Kutxa
-
subject: Listado de palabras clave sobre el tema del recurso.
- Ejemplo: arte, exposiciones, fundación aena,s. xx, colecciones de arte, exposiciones
-
terms_found: Listado de los términos que han coincidido con el patrón de búsqueda.
- Ejemplo: fundación.
Códigos de Estado HTTP
El API de de Liburutegia 2.0 intenta devolver el código de estado HTTP para toda petición, en estilo REST.
- 200 OK : Todo ha ido bien.
- 404 Not Found : No se ha encontrado nigún libro.
- 500 Internal Server Error : Se ha producido un error interno en nuestro código. Por favor, envíanos un email contándonos qué es lo que estabas haciendo cuando ocurrió el error, para que podamos subsanar el problema.
- 503 Service Unavailable : Nuestros servidores en estos momentos no pueden atender tu petición (por parada técnica, sobrecarga, etc.).
Ejemplos de uso
Los siguientes ejemplos ilustran el uso de la API: