Kontsulta geografikoen APIa
Baliabideari buruzko informazioa
- URL
- https://b5m.gipuzkoa.eus/api/2.0/topoquery2
- Erantzun formatuak
- JSON, XML
- Autentifikazioa
- Ez
- Ratio mugatua
- Ez
API honen bidez, Gipuzkoako toponimia eta posta helbideak kontsulta ditzakezu. Horrela, eskura ditzakezu elementu geografikoen datu alfanumerikoak (izenak, posta-helbideak, azaleren datuak, etab.); hala nola puntuen, lerroen eta poligonoen informazio geografiko bektoriala (GeoJSON formatuan). B5m-ko 2.0 bisoreak API hau erabiltzen du kokapen geografikoak zehazteko eta elementu geografikoak arakatzeko. Hiru modutara erabil dezakezu APIa:
1. b5m kode bat ikusi mapa batean
b5m kode bat lortu duzu bilatzaile geografikoaren APIaren bidez eta leku geografiko hori mapa batean kokatu nahi duzu. Hori lortzeko, hau egin behar duzu:
- D_A57413 b5m kodearen kokapena eta irudi bektoriala ikusi nahi dugu (Donostiako Julio Caro Baroja 2 helbideari dagokio, hau da, b5m-ko bulegoa)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?b5mcode=D_A57413&lang=eu
2. Zer da hau?
Gipuzkoako puntu bat zer den jakin nahi duzu. Puntu horren koordenatu parea jaso ondoren, hau egin behar duzu:
- Gipuzkoako koordenatu geografiko pare bat lortu dugu (esate baterako, mapa batean klikatuz), eta klikatutako puntua zer den jakin nahi dugu
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.008015,43.308970&z=16&lang=eu
Kontuan hartu behar duzu, z (balizko maparen zoom maila) edo scale (balizko maparen eskala) parametroen balioek eragina izango dutela emaitzan (begiratu dokumentu honetako azkeneko taulan zer bilatzen ari den kasu bakoitzean). Gipuzkoako elementu guztien artean bilatu nahi baduzu, ez erabili bi parametro horietako bat ere (baina kontuan izan bilaketa oso motela izan daitekeela, Gipuzkoako datu-base geografikoaren elementu geoerreferentziatu guztien artean bilatuko baitu).
3. Zer dago hemen? (poi_pointsofinterest)
Gipuzkoako eremu batean zer dagoen jakin nahi baduzu (interesguneak arlo hauetan: administrazioa, osasuna, kultura eta turismoa), eremu horren laukiaren koordenatuak jaso behar dituzu, poi_pointsofinterest izeneko elementu geografikoa featuretypenames parametroan jarri eta hau egin behar duzu:
- Gipuzkoako lauki baten bounding box-aren koordenatuak lortu ditugu (esate baterako, mapa batean kokatuz), eta eremu horretan zer dagoen jakin nahi dugu (interesguneak)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.0256,43.308573,-1.99501,43.31381&featuretypenames=poi_pointsofinterest&z=18&lang=eu
Eskaeraren parametroak
| Parametroa | Deskribapena | Lehenetsia | Beharrezkoa |
|---|---|---|---|
| coors | Kontsulta egiteko puntuaren edo laukiaren koordenatuak (lauki bat bada, definitu behar da honela). Laukiaren gehinenezko azalera 100 km²-koa da, handiago bada mezu hau azalduko da. | - | Bai, b5mcode parametroa jartzen ez bada |
| offset | Bilaketa egiteko erradioa (metrotan); coors parametroa erabiltzen denean soilik kontuan hartuko da. | 1 | Ez |
| b5mcode | b5m kodea, bilatzaile geografikoaren APIarekin lor daitekeena; jartzen bada, coors parametroa ez da kontuan hartuko. | - | Ez |
| srs | Koordenatuen espazio-erreferentziaren sistema (SRS), EPSG kodean adierazia, jartzen ez bada, sistemak igarriko du. SRS bateragarriak hauek dira: EPSG:4326, EPSG:25830 eta EPSG:3857. | Ez, sistemak igarri dezake | Ez |
| querytype | Kontsultaren mota: regular edo whatishere. Bigarren horretan, interes-puntuen bidezko kontsulta egingo da. | regular | Ez |
| z | Balizko maparen zoom maila. 9 eta 19 arteko baloreak onartuko dira. Parametro honek eragina du bilatuko diren objektu geografikoetan, beheko taulan adierazita dagoen bezala | - | Ez |
| scale | Balizko maparen eskala. 10000000 (1:10.000.000 eskala) eta 500 (1:500 eskala) arteko baloreak onartuko dira. Parametro honek eragina du bilatuko diren objektu geografikoetan, beheko taulan adierazita dagoen bezala | - | Ez |
| featuretypenames | Kontsultatu behar diren elementuen moten zerrenda (komez banatuta); jartzen ez bada, elementu mota guztiak erabiliko dira kontsultan. | guztiak | Ez |
| featuretypes | Elementuen moten zerrenda erakusten du «true» balioa jartzen badugu; lagungarria, featuretypenames parametroa erabili nahi badugu. | false | Ez |
| downloadlist | Deskarga moten zerrenda (kartografia, LIDAR, ortofotoak, etab.) erakusten du «true» balioa jartzen badugu. | false | Ez |
| dwtypeid | Deskarga motaren identifikatzailea. Zenbaki bat da, downloadlist zerrendatik lortzen dena. | false | Ez |
| downloads | Puntu geografiko baten bidezko kontsulta batean (Zer da hau?, coors parametroa erabilita), informazioa puntu horri lotutako deskargekin emateko aukera dago (baina, kontuz, horrela erantzuna motelagoa izango da!), baldintza hauen arabera: downloads=0 bada, informazioa lotutako deskargarik gabe emango da (aukera lehenetsia); downloads=1 bada, lotutako deskargekin emango da; eta, downloads=2 bada, deskargen informazioa besterik ez da emango (featuretypenames=dw_download parametroa bezala). | 0 | Ez |
| geom | «false» balioa jartzen badugu ez du eskainiko elementuen geometria. | true | Ez |
| lang | Hizkuntza. Hiru onartu dira: eu, es eta en. | nabigatzaileak adierazi duena | Ez |
| format | Erantzunaren formatua adierazten du. Honela izan behar du: json edo xml. Lehenetsia json izango da. | json | Ez |
Adibide gehiago
- 1. Koordenatu edo puntu baten kontsulta (EPSG:4326 koordenatu sisteman, longitudea eta latitudea adierazita)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.008015,43.308970&lang=eu
- 2. Aurreko puntuaren kontsulta, baina zoomaren maila adierazita (z=19, emaitzak zehatzagoak izango dira)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.008015,43.308970&z=19&lang=eu
- 3. Koordenatu edo puntu baten kontsulta (EPSG:25830 koordenatu sisteman, x eta y koordenatuak adierazita)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=565019,4776036&lang=eu
- 4. Aurreko puntuaren kontsulta, lotutako deskargak barne (mantsoagoa)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=565019,4776036&downloads=1&lang=eu
- 5. B5m kode baten kontsulta, EPSG:4326 koordenatu sisteman
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?b5mcode=M_010&srs=epsg:4326&lang=eu
- 6. Eskuragarri dauden elementuen izenak zerrendatu (featuretypes) (Oharra: oraindik ez daude b5m-ko elementu guztiak eskuragarri)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?featuretypes=true&lang=eu
- 7. Puntu baten kontsulta, baina zein elementutan bilatu behar den adierazita (m_municipalities)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.397771,43.036122&featuretypenames=m_municipalities&lang=eu
- 8. Puntu baten kontsulta, baina puntu horretan dauden deskargak besterik ez (kartografia, ortofotoak, LIDAR datuak, etab.) (dw_download)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-2.397771,43.036122&featuretypenames=dw_download&lang=eu
- 9. Leiho geografiko baten kontsulta, eta, goiko adibidean bezala, leiho horretan dauden deskargak besterik ez (kartografia, ortofotoak, LIDAR datuak, etab.) (dw_download)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-1.967,43.276,-1.939,43.287&featuretypenames=dw_download&lang=eu
- 10. Deskarga moten zerrenda erakutsi
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?downloadlist=true&lang=eu
- 11. Leiho geografiko baten kontsulta, baina leiho horretan dauden deskarga mota bat besterik ez (dw_type_id=2 duena, «Oinarri topografikoa», alegia) (dw_download eta dwtypeid parametroak)
-
https://b5m.gipuzkoa.eus/api/2.0/topoquery2?coors=-1.967,43.276,-1.939,43.287&featuretypenames=dw_download&dwtypeid=2&lang=eu
(Geroago adibide gehiago jarriko ditugu)
Erantzuna
| Eremua | Deskribapena |
|---|---|
| info | APIari buruzko informazioa: lizentzia, metadatuak, erantzunaren denbora, mezuak, etab. |
| coors | Jaso den koordenatuaren eskaera. |
| offset | Bilaketa egiteko erradioaren informazioa. |
| z | Bilaketa egiteko erabili den zoom maila. |
| crs | Erabili den espazio-erreferentziaren sistema. |
| featuretypenames | Kontsulta egiteko erabili den elementuen zerrenda. |
| numberMatched | Aurkitu diren elementuen kopurua. |
| features | Elementu jakin batean aurkitu diren kointzidentzia geografikoak, GeoJSON formatuan. Datuak OGC WFS zerbitzu baten GetFeature eskaera batetik datoz; b5m-ko gipuzkoa_wfs WFS zerbitzutik, hain zuzen. |
| downloads | «Zer da hau?» kasuan (bigarren kasua) denean, leku horretan aurkitu den datuen deskargen zerrenda (ortofotoak, oinarri kartografikoa, BTA datuak, lidar datuak, etab.). |
| more_info | Aurreko kasuan bezala, baina orain adierazten du ea koordenatuen bidezko bilaketan elementu gehiago aurkitu diren (betiere eskaeran adierazitako zoom-mailari dagokiona eta koordenatuak mapako puntu bati badagozkio). |
| external_links | Bilaketa puntu baten bidezkoa izan bada, erantzunak kanpoko esteken informazioa emango du. |