Rajapintojen käyttö

API-portaali kokoaa yhteen paikkaan Valtiokonttorin ylläpitämät rajapintakokonaisuudet. Kukin rajapintakokonaisuus on itsenäinen palvelunsa ja yksittäinen palveluntuottaja vastaa palvelunsa tietosisällöstä. Tästä johtuen rajapinnoissa ja niiden tietosisällöissä on eroja. Kunkin rajapinnan kutsumisesta on esitetty esimerkki rajapinnan dokumentaatiossa. Tarkemmat tiedot löytyvät kunkin rajapinnan yhteydestä.

Parametrien antaminen rajapintakutsuissa

Kutakin rajapintaa kutsutaan HTTPS-osoitteen kautta, joka muodostuu seuraavista osista:

  • APIen oma verkkotunnus https://api.tutkihallintoa.fi

  • APIn oma tunnus (esim. talous)

  • Halutun API-version versiotunnus (esim. v1)

  • Kutsuttava API-operaatio (esim. luvut)

  • Mahdolliset parametrit muodossa ?{parametrin 1 nimi}={parametrin 1 arvo}{&parametrin 2 nimi}={parametrin 2 arvo}

Esimerkiksi Valtion talous-APIn version 1 operaatiota luvut parametrilla pääluokka ja arvolla 25 kutsuttaisiin seuraavasti:

GET https://api.tutkihallintoa.fi/talous/v1/luvut?paaluokka=25