Avoimen datan rajapintaratkaisujen käytettävyyden arviointi

Abstract

Avoimen tiedon yleistyessä ja sen määrän kasvaessa jatkuvasti valtavaa vauhtia, on entistä tärkeämpää, että kyseistä dataa osataan hyödyntää mahdollisimman tehokkaasti ja taitavasti. Ilman tiedon tehokasta tarjoamista mahdollisimman monelle käyttäjälle jää suuri osa avoimen tiedon potentiaalista mitä todennäköisimmin hyödyntämättä. Tähän haasteeseen voidaan vastata muun muassa entistä helpompikäyttöisten rajapintaratkaisujen avulla. Suomessa avoimen tiedon merkitys on tunnistettu ja hallitus onkin aloittanut tiedon hyödyntämisen ja avaamisen hankkeen. Hanke on asetettu vuosiksi 2020-2022.

Tämä tutkielma toteutettiin osana tiedon hyödyntämisen ja avaamisen hanketta. Työn tavoitteena oli selvittää tällä hetkellä Suomessa käytössä olevien rajapintaratkaisujen hyvät ja huonot puolet, arvioida rajapintojen käytettävyyttä niin tutkijan oman selvityksen kuin rajapintojen hyödyntäjien kautta ja lopulta hahmotella API-linjaukset, joita voitaisiin hyödyntää varsinaisessa tiedon hyödyntämisen ja avaamisen hankkeessa. Rajapintojen hyödyntäjien kokemuksia ja ajatuksia kerättiin kymmenen avointa kysymystä sisältävän nettikyselyn kautta, johon saatiin lopulta 24 vastausta. Haastateltavat kerättiin avoindata.fi-sivustolta löytyvien avoimen datan päälle tehtyjen sovellusten kautta sekä THL:n avustuksella heidän rajapintoja hyödyntävistä henkilöistään. Käyttäjiltä saatiin paljon hyödyllisiä vastauksia, joiden pohjalta API-linjauksia pystyttiin tekemään.

Tärkeiksi kohdiksi rajapinnan käytettävyyden kannalta nostettiin muun muassa dokumentoinnin laadukkuus ja oikeellisuus, rajapinnan funktioiden sekä parametrien loogisuus, rajapinnan käyttäjäkuorman tiedostaminen ja rajapinnan käyttötapausten sekä elinkaaren ymmärtäminen. Avoimen tiedon on tärkeää olla mahdollisimman vaivattomasti kaikkien saatavilla, jotta siitä voidaan saada maksimaalinen hyöty yhteiskunnalle.

While the volume of open data increases and open data becomes more common, it is very important to be able to use and exploit this data to its full potential. Without the ability to offer data efficiently to everyone, some of its possibilities will most likely be wasted. This challenge can be tackled with the development of efficient and user-friendly application programming interfaces. In Finland the importance of open data has been noted and the Finnish government has started its own plan for exploiting and opening data. This plan has been set for years 2020-2022.

This study belongs to the plan of exploiting and opening data. The goal of this thesis is to find out what are the positive and negatives sides of currently available application programming interfaces (APIs) in Finland, evaluate the usability of the APIs based on the author’s own research and the experience of people who have been using and working with these APIs. In the end, API policies will be suggested, in order to help the people working with the plan make correct decisions. The research material was collected using a questionnaire, which consisted of ten open ended questions. The questionnaire resulted in 24 answers. The users of the application programming interfaces were recognized from a website called avoindata.fi and with the help of THL, from the users of the application programming interfaces offered by them. A lot of interesting and useful answers were collected.

The study showed that if we want the API to be user-friendly, the documentation of the API must be reliable and in good quality, the names of the API functions and parameters must be logical, the API must work correctly even when the load becomes heavy and that the API’s whole lifeline must be taken into account, when starting to design and create it in the first place. It is important that open data is available to everyone, so that it can be utilized effectively to cause positive effects to the whole society.