Liburutegiaren APIa
Koldo Mitxelena Liburutegiak bere liburutegian gordetzen diren liburuen informaziora sarbidea REST motako API (Application Programming Interface) baten bitartez eskaintzen du. Dokumentu honek eskainitako funtzionalitatea deskribatzen du eta Liburutegiko informaziora sarbidea emango duten tresnak garatzerakoan programatzaileei lagundu nahi die.
Edukiak
Sarbidea baliabide baten fitxara
Baliabide baten datuak itzultzen ditu
URLa: http://liburutegia.gipuzkoa.net/api/rest/1.0/book/erreferentzia.xml
HTTP metodoa: GET
Emaitza: Baliabidearen datuak Dublin Core notazioa jarraituz.
XML adibidea
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>
Baliabideen bilaketa
Bilaketa irizpideekin bat datorren baliabide zerrenda itzultzen du.
URL: http://liburutegia.gipuzkoa.net/api/rest/1.0/books.formatua formatua = xml, rss, js, json, html
HTTP metodoa: GET
Parametroak:
-
q: Hautazkoa. Bilaketaren gakoa (testu librea).
Adib: http://liburutegia.gipuzkoa.net/api/rest/1.0/books.xml?q=fundacion - author: Hautazkoa. Egilearen izena.
- title: Hauztakoa. Baliabidearen izenburua.
- isbn: Hautazkoa. Baliabidearen ISBNa.
-
keywords: Hautazkoa. Baliabideari buruzko gaiak.
Adib: http://liburutegia.gipuzkoa.net/api/rest/1.0/books.xml?keywords=beasain
Emaitza: Aurkitu diren baliabideen zerrenda.
XML adibidea
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>
Itzulitako objetuak
Baliabideen zerrenda
Ondorengo berezitasunetako objetuekin osatutako Array-a:
-
reference: Baliabidearen identifikadorea.
- Adib: 000000432888
-
title: Baliabidearen izenburua.
- Adib: Aena
-
subtitle: Baliabidearen azpititulua.
- Adib: Arte garaikideko bilduma : [Artearen Kutxaguneko Kubo Aretoan] = Colección de arte contemporáneo : [Sala Kubo-Kutxaespacio del Arte]
-
authors: Egileen zerrenda.
- Adib: Fundación Kutxa
-
summary: Baliabideari buruzko irizpideak.
- Adib: Textos en euskera, castellano, francés e inglés
-
CDU: Baliabidearen signatura.
- Adib: 7.036 FUN AEN
-
year: Argitarapen urtea.
- Adib: 2002
-
series: Baliabideari dagokion taldea.
- Adibidea: Kubo-Kutxa
-
subject: Baliabidearen gaiari buruzko hitz gakoen zerrenda.
- Adibidea: arte, exposiciones, fundación aena,s. xx, colecciones de arte, exposiciones
-
terms_found: Bilaketa irizpideekin bat etorri diren gaien zerrenda.
- Adibidea: fundazioa.
HTTP egoeraren kodea
Liburutegia 2.0ren APIak eskaera guztientzako HTTP egoeraren kodea REST estiloan itzultzen saiatzen da.
- 200 OK : Ez da arazorik izan.
- 404 Not Found : Ez da libururik aurkitu.
- 500 Internal Server Error : Gure kodean barne errorea gertatu da. Bidali iezaiguzu email bat eta errorea gertatu denean egiten ari zinena azaldu iezaiguzu, hartara, arazoa konpondu dezagun.
- 503 Service Unavailable : Gure zerbitzariek une honetan ezin dute zure eskaera osatu (geldiune teknikoak, gainkarga, etabar.).
Erabilpen adibideak
Adibideek APIaren erabilpen modu batzuk erakusten dituzte: