Citynature.eu tarjoaa avoimen REST-rajapinnan, jonka kautta voi käyttää sivuilla olevaa tietoa sekä Helsingin että Tallinnan luontoreiteistä.
Verkkosivuston sisällöt eivät ole kokonaisuudessaan käytettävissä rajapinnan kautta, mutta jokaisesta kohteesta on valmiita reittiehdotuksia sekä reittipisteitä, jotka ovat käytettävissä. Reiteillä on erilaisia teemoja (geologinen polku, lapsille suunnattu luontopolku, opetuskäyttöön soveltuvat ilmiöoppimisrastit ym.), joista kerrotaan reittipisteiden sisällöissä.
Helsingin kaupungilla on Helsinkiä koskeviin kuviin kaikki oikeudet ja Tallinnan kaupungilla Tallinnaa koskevien kuvien oikeudet. Rajapinnassa tarjolla olevia kuvia saa käyttää ainoastaan kuvaan liittyvää luontoreittiä käsittelevään tiedotukseen ja viestintään. Kuvien käyttäminen tähän tarkoitukseen on käyttäjälle ilmaista. Kuvan käyttö tai siirto muihin tarkoituksiin on kielletty. Kuvia käytettäessä on ehdottomasti mainittava kuvien lähde ja kuvaaja.
Helsingin kohteiden sisällöt ovat saatavilla suomeksi, ruotsiksi, englanniksi ja viroksi. Tallinnan kohteiden sisällöt ovat saatavilla suomeksi, englanniksi, viroksi ja venäjäksi.
Tekniset ohjeet
Paikkojen rajapinta sijaitsee osoitteessa: https://citynature.eu/api/wp/v2/places
Jotta kaupungin paikat saadaan rajapinnasta, tulee rajapintaan antaa parametri cityid, joka on kyseisen kaupungin id. Esimerkiksi Helsingin kaupungin paikat suomen kielellä saadaan rajapintapyynnöllä https://citynature.eu/api/wp/v2/places?cityid=5
Rajapintapyyntö palauttaa vastauksena:
- paikan ID
- paikan otsikko
- paikan URL citynature.eu -palvelussa
- paikan reitit
- paikan reittipisteet
- paikan reittipisteiden kuvaukset html-muodossa
Kaupunkien rajapinta
Kaupunkien ID:t voi hakea rajapinnasta https://citynature.eu/api/wp/v2/cities. Jotta ID:t saadaan oikealla kielellä, tulee rajapintaan antaa parametri lang. Esimerkiksi: https://citynature.eu/api/wp/v2/cities?lang=fi
Kaupunkien lang-parametri vaihtoehdot ovat:
- fi (suomi)
- en (englanti)
- et (viro)
- sv (ruotsi)
- ru (venäjä)