Picture

Rajapintojen käyttö

Tutki hallintoa -rajapinnat ovat REST-rajapintoja, joita käytetään HTTP-kutsuilla. Rajapinnat on niputettu kokonaisuuksiksi, kuten Valtion talous, Valtion henkilöstö ja Kuntadata, jotka sisältävät useamman eri rajapintakomennon. Jokaista komentoa voidaan kutsua sekä HTTP GET- että HTTP POST-metodilla. Komentojen palauttama sisältö on samanlaista metodista riippumatta, mutta metodilla voidaan valita palautettavan sisällön muoto seuraavasti:

  • HTTP GET: Tiedot palautuu ladattavana csv-tiedostona UTF-8 -enkoodattuna.

  • HTTP POST:Tiedot palautuu HTTP-vastauksen sisältönä joko csv- tai json-muodossa pyynnöstä riippuen, UTF-8 -enkoodattuna.

HTTP POST-pyynnön mukana voidaan antaa Accept-otsakkeessa vastauksen toivottu muoto. Oletusarvoisesti rajapinta palauttaa vastauksen csv-muodossa, mutta json-muotoisen vastauksen saa otsakkeen arvolla ”application/json”. Alla on esimerkit csv- ja json-muotoisista rajapinnan vastauksista:

Csv-muotoinen vastaus:

Id,Tunnus,NimiFi,NimiSv,NimiEn,Vuosi
1,"21","Tasavallan presidentti","Republikens president"," ","1998"
2,"22","Eduskunta","Riksdagen"," ","1998"

Json-muotoinen vastaus:

[{
"Id": 1,
"Tunnus": "21",
"NimiFi": "Tasavallan presidentti",
"NimiSv": "Republikens president",
"NimiEn": " ",
"Vuosi": "1998"
}, {
"Id": 2,
"Tunnus": "22",
"NimiFi": "Eduskunta",
"NimiSv": "Riksdagen",
"NimiEn": " ",
"Vuosi": "1998"
}]

Rajapintaparametrit

Rajapintakomentojen komentokohtaiset parametrit annetaan URL-parametreina komennon osoitteen perässä. Parametreja käytetään komennon palauttamien arvojen rajaamiseen, esimerkiksi seuraava komento palauttaisi vain annettuun pääluokkaan 25 kuuluvat luvut:

GET https://tutkihallintoa.azure-api.net/talous/Luvut?paaluokka=25

Komentokohtaiset parametrit ja niiden kuvaukset löydät rajapintojen kuvauksista.

Koostetiedostot

Tutki hallintoa -rajapintojen tarjoamat tiedot on saatavilla myös csv-muotoisina koostetiedostoina esimerkiksi tilastollista käsittelyä varten:

  • Valtion talous -tiedot kuukausitasolla, esimerkiksi marraskuu 2019

AJantasainen listaus kaikista koostetiedostoista on saatavissa ohjelmallisesti json-formaatissa rajapintojen kautta:

  • Valtion talous -BudjettitalousVuosiKuukausi

Käyttörajoitteet

Tutki hallintoa -rajapintojen käyttöä on rajoitettu siten, että yhdestä IP-osoitteesta voidaan tehdä korkeintaan viisi rajapintakutsua minuutin aikana.