Suomi.fi-palvelutietovarannon avoin REST API on käytössä

apisuomi
API:Suomi
Published in
1 min readJul 30, 2016
ptv-swagger

Suomi.fi-palvelutietovaranto (palvelutietovaranto, PTV) on keskitetty tietovaranto, johon organisaatiot, joilla on joko käyttövelvollisuus tai käyttöoikeus, tuottavat tiedot tarjoamistaan palveluista ja asiointikanavista sekä palveluun kytkeytyvän organisaation tiedoista. Rajapinta kehittyy ja parantuu koko ajan, samoin vielä käytännöt sen ympärillä muuttuu tulevaisuudessa sanoo Nina Wiiala Väestörekisterikeskuksesta:

“Avoimen rajapinnan GET-metodien käyttö on toistaiseksi täysin avointa, ennen kuin saadaan jokin väline Api-avainten automaattiseen generointiin ja hallinnointiin. Palveluväylän liityntäkatalogiin on myös tarkoitus laittaa kaikkien integraatioiden kuvaukset, vaikka integraatio ei kulkisikaan Palveluväylän kautta.”

Käyttöoikeudesta ja käyttövelvollisuudesta säädetään ns. KaPA-laissa eli laissa hallinnon yhteisistä sähköisen asioinnin tukipalveluista (571/2016). Palvelua tuottaa Väestörekisterikeskus.

Swagger dokumentaatio

Suomi.fi-palvelutietovarannon avoimen rajapinnan (Open Api) ensimmäinen versio 1.0 on julkaistu pilottikäyttöön 23.6.2016. Avoimen rajapinnan kuvaukset ovat saatavilla Swaggerissa osoitteessa http://ptvenv.cloudapp.net:1494/swagger/ui/index.html#/ Rajapinnan seuraava versio 1.1 julkaistaneen 10.8.2016.

Myös dokumentaatio tarkentuu ajan kanssa, sanoo Nina Wiiala:

“Tuo on vielä tynkädokumentaatio, mutta tarkentuu kunhan päivittäjät palaavat lomilta. Swagger toimii kuitenkin aika hyvänä kuvauksena kehittäjille. “

--

--