API delakoa datos.gob.es atariko datu-base semantikoa kontsultatzeko mekanismo bat da. Sarbidea ematen du Datuen katalogoko informaziora eta Informazio-baliabideak Berrerabiltzeko Elkarreragingarritasun Arau Teknikoaren IV. eta V. eranskinetan definitutako URIetara.
Honelako kontsultak gauzatzeko, erabiltzaileak zenbait irizpide ezarri ahal ditu, eta baliabideen identifikatzaile uniformeak erabiltzen dira (URI).
Erantzunen formatuak
APIren bitartez eskuragarri dagoen informazioa hainbat formatutan eskura daiteke. Hauek dira eskuragarri dauden formatuak: json, xml, rdf, ttl eta csv.
Besterik adierazi ezean, JSON formatuan ematen dira emaitzak. Adibidez: nabigatzailean http://datos.gob.es/apidata/catalog/dataset API baliabidean sartzen bazara, emaitza JSON formatuan emango da.
Bi aukera daude zein formatu nahi duzun adierazteko:
- Eskaeraren goiburuetan,
'Accept'parametroaren bitartez. Esaterako:Accept:application/rdf+xml - Eskaeran formatua honen luzapenaren bitartez adieraziz. Esaterako:
http://datos.gob.es/apidata/catalog/dataset.xml
| Formatua | 1. Header 'Accept' | 2. Formatuaren luzapena |
|---|---|---|
| JSON | application/json | .json |
| XML | application/xml | .xml |
| RDF | application/rdf+xml | .rdf |
| Turtle | application/x-turtle | .turtle |
| CSV | text/csv | .csv |
API parametroak
APIak emaitzak pertsonalizatzeko balio duten zenbait parametro eskaintzen ditu:
| Parametroa | Deskribapena | Adibidea |
|---|---|---|
_sort | Parametro honek emaitzak ordenatzeko balio du, emaitza eremu baten edo gehiagoren arabera. Emaitzak zen eremuren arabera ordenatu nahi diren adierazi behar da, eremuaren izena idatzita. Ordena alderantzikatzeko, minus ikurra '-' idatzi behar da eremuaren izenaren aurrean. Eremu bat baino gehiago zehaztu daiteke, haien artean koma ',' idatzita. | Adibidez, datu-multzoak dataren (berrienetik zaharrenera) eta izenburuaren arabera ordenatuta eskuratu nahi baditugu:http://datos.gob.es/apidata/catalog/dataset.json?_sort=-issued,title |
_pageSize | Parametro hau orrialde bakoitzeko azalduko den emaitza kopurua ezartzeko erabiltzen da. Gehienezko balioa 50 da. | Esaterako, emaitzak banaka lortzeko:http://datos.gob.es/apidata/catalog/dataset.xml?_pageSize=1 |
_page | Parametro hau zein orrialde kontsultatzen ari garen adierazteko erabiltzen da. Hasierako orrialdea 0 da. | Adibidez, emaitzen hirugarren orrialdea kontsultatzeko: http://datos.gob.es/apidata/catalog/dataset.xml?_pageSize=1&_page=2 |
Dei erabilgarriak
Datuen katalogoa
datos.gob.es atariko Datuen katalogoa kontsultatzeko balio dute deiak.
| Eragiketa | Deskribapena | Adibideak |
|---|---|---|
| Datu-multzo guztiak bistaratu | http://datos.gob.es/apidata/catalog/dataset | |
| Datu-multzoa URI identifikatzailearen arabera bistaratu | http://datos.gob.es/apidata/catalog/dataset/{id}{id}-(r)en balioa zehaztu behar da. | Esaterako, {id}-(e)k 'a16003011-empresas-y-personas-empleadas-en-la-c-a-de-euskadi-supervivientes-en-2015-altas-en-los-cinco-anos-anteriores-por-territorio-y-comarca-de-sede-social' balioa baldin badu, deia honako hau da: http://datos.gob.es/apidata/catalog/dataset/a16003011-empresas-y-personas-empleadas-en-la-c-a-de-euskadi-supervivientes-en-2015-altas-en-los-cinco-anos-anteriores-por-territorio-y-comarca-de-sede-social |
| Izenburu jakin bat duten datu-multzoak bistaratu | http://datos.gob.es/apidata/catalog/dataset/title/{title}{title}-(r)en balioa zehaztu behar da. Izenburuaren zati bat izan daiteke. | Esaterako, {title}-(e)k balio hau baldin badu: 'empleo', deia honako hau izango da: http://datos.gob.es/apidata/catalog/dataset/title/empleo |
| Identifikatzailearen bitartez, argitaratzaile jakin baten datu-multzoak bistaratu | http://datos.gob.es/apidata/catalog/dataset/publisher/{id}{id}-(r)en balioa zehaztu behar da. | Esaterako, {id}-(e)k balio hau baldin badu: 'A16003011', deia honako hau izango da: http://datos.gob.es/apidata/catalog/dataset/publisher/A16003011 |
| Identifikatzailearen bitartez, kategoria edo gai jakin bateko datu-multzoak bistaratu | http://datos.gob.es/apidata/catalog/dataset/theme/{id}{id}-(r)en balioa zehaztu behar da. | Esaterako, {id}-(e)k balio hau baldin badu: 'hacienda', deia honako hau izango da: http://datos.gob.es/apidata/catalog/dataset/theme/hacienda |
| Banaketak dituzten datu-multzoak formatu jakin batean bistaratu | http://datos.gob.es/apidata/catalog/dataset/format/{format} | Esaterako, {format}-(e)k balio hau baldin badu: 'csv', deia honako hau izango da: http://datos.gob.es/apidata/catalog/dataset/format/csv |
| Etiketa jakin bat duten datu-multzoak bistaratu | http://datos.gob.es/apidata/catalog/dataset/keyword/{keyword} | {keyword}-(e)k balio hau baldin badu: 'gastos', deia honako hau izango da: http://datos.gob.es/apidata/catalog/dataset/keyword/gastos |
| Eremu geografiko jakin bateko datu-multzoak bistaratu | http://datos.gob.es/apidata/catalog/dataset/spatial/{spatialWord1}/{spatialWord2}Dei honetan bi parametro erabiltzen dira: {spatialWord1} eta {spatialWord2}. | {spatialWord1}-(e)k balio hau baldin badu: 'Autonomia' eta {spatialWord2}-(e)k balio hau baldin badu: 'Pais-Vasco', deia honako hau izango da: http://datos.gob.es/apidata/catalog/dataset/spatial/Autonomia/Pais-Vasco |
| Bi data jakinen artean eguneratu diren datu-multzoak bistaratu: | http://datos.gob.es/apidata/catalog/dataset/modified/begin/{beginDate}/end/{endDate}Dei honetan bi parametro erabiltzen dira: {beginDate} eta {endDate}. Horien formatua hurrengoa izan behar da: AAAA-MM-DDTHH:mmZ. | {beginDate}-(e)k balio hau baldin badu: 2016-04-18T00:00Z eta {endDate}-(e)k balio hau baldin badu: 2016-06-30T00:00Z, deia honako hau izango da: http://datos.gob.es/apidata/catalog/dataset/modified/begin/2016-04-18T00:00Z/end/2016-06-30T00:00Z?_sort=title&_pageSize=10&_page=0 |
| Eragiketa | Deskribapena | Adibideak |
|---|---|---|
| Banaketa guztiak bistaratu | http://datos.gob.es/apidata/catalog/distribution | |
| URI identifikatzailea erabiliz, datu-multzo baten banaketa guztiak bistaratu | http://datos.gob.es/apidata/catalog/distribution/dataset/{id}{id}-(r)en balioa zehaztu behar da. | Si {id}-(e)k balio hau baldin badu: 'a16003011-empresas-y-personas-empleadas-en-la-c-a-de-euskadi-supervivientes-en-2015-altas-en-los-cinco-anos-anteriores-por-territorio-y-comarca-de-sede-social', deia honako hau izango da: http://datos.gob.es/apidata/catalog/distribution/dataset/a16003011-empresas-y-personas-empleadas-en-la-c-a-de-euskadi-supervivientes-en-2015-altas-en-los-cinco-anos-anteriores-por-territorio-y-comarca-de-sede-social |
| Formatu jakin batean dauden banaketak bistaratu | http://datos.gob.es/apidata/catalog/distribution/format/{format} | Si {format}-(e)k balio hau baldin badu: 'csv', deia honako hau izango da: http://datos.gob.es/apidata/catalog/distribution/format/csv |
| Eragiketa | Deskribapena | Adibideak |
|---|---|---|
| Argitaratzaile guztiak bistaratu | http://datos.gob.es/apidata/catalog/publisher |
| Eragiketa | Deskribapena | Adibideak |
|---|---|---|
| Katalogoko datu-multzoek dituzten estaldura geografikoko aukera guztiak bistaratu | http://datos.gob.es/apidata/catalog/spatial |
| Eragiketa | Deskribapena | Adibideak |
|---|---|---|
| Katalogoko datu-multzoen kategoria edo gai aukera guztiak bistaratu | http://datos.gob.es/apidata/catalog/theme |
Elkarreragingarritasun Arau Teknikoa
Lehen sektoreen taxonomiako eta estaldura geografikoaren identifikazioko edukiak kontsultatzeko balio duten deiak, Informazio-baliabideak Berrerabiltzeko Elkarreragingarritasun Arau Teknikoaren (NTI) V. eta V. eranskinetan definituak.
| Eragiketa | Deskribapena | Adibideak |
|---|---|---|
| Lehen sektore guztiak bistaratu | http://datos.gob.es/apidata/nti/public-sector | |
| Sektore jakin bat URI identifikatzailear en arabera bistaratu | http://datos.gob.es/apidata/nti/public-sector/{id}{id}-(r)en balioa zehaztu behar da. | Esaterako, {id}-(e)k balio hau badu: 'comercio', deia honako hau izango da: http://datos.gob.es/apidata/nti/public-sector/comercio |
| Eragiketa | Deskribapena | Adibideak |
|---|---|---|
| Probintzia guztiak bistaratu | http://datos.gob.es/apidata/nti/territory/Province | |
| URI identifikatzailearen bidez, probintzia jakin bat bistaratu | http://datos.gob.es/apidata/nti/territory/Province/{id}{id} | Esaterako, {id}-(e)k balio hau badu: 'Madrid', deia honako hau izango da: http://datos.gob.es/apidata/nti/territory/Province/Madrid. |
| Autonomia-erkidego guztiak bistaratu | http://datos.gob.es/apidata/nti/territory/Autonomous-region | |
| URI identifikatzailearen bidez, autonomia-erkidego jakin bat bistaratu | http://datos.gob.es/apidata/nti/territory/Autonomous-region/{id}{id}-(r)en balioa zehaztu behar da. | Esaterako, {id}-(e)k balio hau badu: 'Comunidad-Madrid', deia honako hau izango da: http://datos.gob.es/apidata/nti/territory/Autonomous-region/Comunidad-Madrid |
| Herrialdea bistaratu | http://datos.gob.es/apidata/nti/territory/Country/España |