Rajapinnat näkyviin avoindata.fi-palvelussa

Avoindata.fi:hin on tulossa 20.10.2022 iso parannus, sillä eriytämme palveluun lisätyt ohjelmointirajapinnat (APIt) omalle sivulleen. Tähän asti kaikki palveluun lisätty data on näkynyt tietoaineistoina.  

Rajapintojen oma sivu löytyy avoindata.fi:n navigaatiopalkista.

Palveluun lisättyjä ohjelmointirajapintoja on siis jatkossa huomattavasti helpompi hakea ja selata. Niistä tarjotaan olennaisempia metatietoja, sillä ne kuvaillaan palveluun hieman eri tavalla kuin tietoaineistot. 

Käy tutustumassa uuteen rajapintasivuun ja kerro, mitä mieltä olit ja mitä ominaisuuksia haluaisit nähdä tulevaisuudessa. 

Valmistaudumme avoimen datan direktiivin käyttöönottoon ja ohjelmointirajapintojen kasvavaan kysyntään

Usein päivittyvää tai jatkuvasti muuttuvaa tietoa on yhteiskunnassa entistä enemmän. Myös moni avointa tietoa hyödyntävä sovellus pohjautuu jatkuvasti päivittyvään tietoon. Esimerkiksi Sporat.fi-sovellus visualisoi Helsingin raitiovaunujen sijaintia kartalla, joka muuttuu lähes joka sekunti. Tällaista jatkuvasti muuttuvaa tietoa ei ole järkevää tai usein edes mahdollista jakaa tiedostona. Se vaatisi tiedostojen jatkuvaa päivittämistä tai suuren määrän versiointia. Tiedonhallinta olisi käytännössä mahdotonta.

Parempi tapa jakaa tämän tyylistä tietoa on ohjelmointirajapinta (API). Avoimen datan kentällä ohjelmointirajapintoja on alettu hyödyntää yhä enemmän. Haluamme avoindata.fi:ssä vastata kysyntään ja parantaa rajapintojen näkyvyyttä palvelussa. Datan hyödyntäjiäkin auttaa, että avointa dataa tarjoavat rajapinnat löytyvät helposti yhdestä paikasta yhtenäisellä tavalla kuvailtuna. 

Lisäksi valmistaudumme rajapintaominaisuuksilla avoimen datan direktiivin ja arvokkaiden tietoaineistojen täytäntöönpanon tuomiin muutoksiin. Vuonna 2019 julkaistussa avoimen datan direktiivissä nostettiin ohjelmointirajapinnat esiin tapana jakaa avointa tietoa (direktiivin artikla 5). Direktiivissä arvokkaiksi määriteltyjen tietoaineistojen tulisi olla saatavilla pitkälti rajapintojen kautta, joten palvelulle, johon voi lisätä rajapintoja tulee olemaan tarvetta. 

DCAT-AP-metatietomallia laajennettu kattamaan myös rajapinnat

DCAT-AP-standardissa määritellään, miten Euroopan avoimen datan portaaleihin lisätty data pitäisi kuvailla, eli millaisia metatietoja datasta vaaditaan. Datan kuvaileminen yhtenäisellä tavalla on tärkeää, sillä jäsenmaiden avoin data päätyy yhteiseen Euroopan komission palveluun data.europa.eu:hun. Ilman yhtenäistä tapaa kuvailla avoimia tietoaineistoja, niiden kerääminen yhteen paikkaan ei olisi mahdollista.

Nykyinen tietomalli (DCAT-AP) on kehitetty lähinnä tiedostoja varten eikä sen kehittämisessä ole juurikaan ajateltu ohjelmointirajapintoja. Sen takia olemme luoneet oman laajennoksen tietomalliin ohjelmointirajapintoja varten. Palvelussamme tämä näkyy siten, että ohjelmointirajapinnoista vaaditaan hieman erilaisia metatietoja kuin tietoaineistoista, kuten tieto ohjelmointirajapinnan käyttöoikeuksista, kun taas tietoaineiston kuvailussa tiedolle ei ole tarvetta. Laadukkaat metatiedot auttavat tiedon hyödyntäjiä hyödyntämään ohjelmointirajapintojen avulla julkaistua avointa tietoa. 

Uudet rajapintaominaisuudet toistaiseksi testikäytössä 

Rajapinnat-sivu on aluksi testikäytössä, joten kaikki palvelun rajapinnat eivät vielä löydy sieltä. Tällä hetkellä ainoastaan Paikkatietohakemistosta tulevat rajapinnat näkyvät uudella sivulla. Alamme lisätä rajapintojen määrää, kun olemme tyytyväisiä uusiin ominaisuuksiin ja varmistaneet, että kaikki toimii. 

Jos haluat hakea rajapintoja ja tietoaineistoja yhdellä haulla, käytä laajennettua hakua. Toteutamme sivustolle myöhemmin yleishaun, jolla voi hakea kaikkea palvelusta löytyvää dataa.

Jatkamme rajapintaominaisuuksien kehittämistä ketterän kehittämisen oppien mukaisesti tulevina vuosina. Visiomme on, että avointa tietoja jakavien ohjelmointirajapintojen käyttö on Suomessa ja Euroopassa mahdollisimman helppoa ja nopeaa. Haaste on niin monimutkainen, ettei kaikkia asioita voi edes suunnitella ennakolta, vaan parannamme ominaisuutta asiakaspalautteen avulla pienin askelin.

Muutokset datan tuottajille ja hyödyntäjille

Suurimmat muutokset datan tuottajille:

  • Rajapinnat lisätään avoindata.fi:hin eri sivulta kuin tietoaineistot.
  • Rajapinnat kuvaillaan hieman eri tavalla, eli niistä vaaditaan erilaisia tietoja kuin tietoaineistoista.

Jos organisaatiosi on jo julkaissut ohjelmointirajapintoja avoindata.fi:ssä tietoaineistoina, otamme aineiston ylläpitäjään myöhemmin yhteyttä ja ohjeistamme, miten ohjelmointirajapinta kannattaa lisätä palveluumme.

Julkaisemme ohjeet tietoaineistojen muuttamiseen rajapinnoiksi ja rajapintojen lisäämiseen myöhemmin. Avustamme lisäämisessä tarvittaessa.

Jatkossa datan tuottaja on vastuussa siitä, että ohjelmointirajapinnat ovat lisätty palveluun rajapintoina ja tiedostot tietoaineistoina. 

Suurimmat muutokset datan hyödyntäjille:

  • Joidenkin aineistojen osoitteet saattavat muuttua, jos aineisto on lisätty aiemmin avoindata.fi:hin tietoaineistona ja siirretty jälkeenpäin rajapinnaksi.
  • Jos haluat etsiä sekä rajapintoja että tietoaineistoja, käytä laajennettua hakua. 

Mikä on ohjelmointirajapinta ja millaisia rajapintoja voi lisätä avoindata.fi:hin?

Ohjelmointirajapinnat eli APIt (Application Programming Interface) ovat dokumentoituja rajapintoja, joiden avulla ohjelmistot, sovellukset tai järjestelmät voivat vaihtaa keskenään tietoa tai toimintoja. Ohjelmointirajapinta tarjoaa tietoa tai toimintoa koneluettavassa, dokumentoidussa muodossa siten, että jokin toinen ohjelmisto, sovellus tai järjestelmä voi sitä ohjelmallisesti hyödyntää. Esimerkiksi joukkoliikenteen rajapinta kertoo reittiopas-sovellukselle, milloin bussisi saapuu pysäkille. 

Avoindata.fi:n Rajapinnat-sivulle kuvataan ainoastaan ohjelmointirajapintoja ei esimerkiksi rajapinnan kautta saatavia aineistoja. 

Esimerkki paikkatietojen kuvaamisesta
Kaupungilla on yksi WMS-paikkatietorajapinta, joka tarjoaa erilaisia paikkatietoaineistoja. Kaupunki lisää WMS-rajapinnan avoindata.fi:hin rajapintana ja ohjelmointirajapinnan tarjoamat aineistot tietoaineistoina. Myöhemmin kaupunki voi linkittää ohjelmointirajapinnan tarjoamat tietoaineistot avoindata.fi:hin lisättyyn rajapintaan.  

Jos sinulla on kysymyksiä, ota meihin yhteyttä yhteydenottolomakkeella