För anvisningar på svenska se nedan | For instructions in English see below

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

//

Användning av gränssnitten

I API-portalen finns de gränssnittshelheter om Statskontoret upprätthåller samlade på ett ställe. Varje gränssnittshelhet är en självständig tjänst och en enskild serviceproducent ansvarar för informationsinnehållet i sin tjänst. Därför finns det skillnader i gränssnitten och deras informationsinnehåll. Ett exempel på anrop för varje gränssnitt finns i gränssnittets dokumentation. Närmare information finns i anslutning till varje gränssnitt.

Parametrar i gränssnittsanrop

Varje gränssnitt anropas via en HTTPS-adress som består av följande delar:

  • API:s eget domännamn https://api.tutkihallintoa.fi

  • API:s egen kod, (t.ex. ekonomi, talous)

  • Versionskod för önskad API-version (t.ex. v1)

  • API-operation som anropas (t.ex. tal, luvut)

  • Eventuella parametrar i formatet ?{parameter 1 namn}={parameter 1 värde}{& parameter 2 namn}={parameter 2 värde}

Till exempel skulle operationen tal (luvut) i version 1 av Statens ekonomi-API med parametern huvudklasser (pääluokat) och värdet 25 anropas enligt följande:

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

//

Use of interfaces

The API portal brings together the interface entities maintained by the State Treasury. Each interface entity is an independent service, and an individual service provider is responsible for the data content of its service. For this reason, there are differences in interfaces and their data content. An example of calling each interface is presented in the interface documentation. More detailed information can be found in connection with each interface.

Entering parameters in interface calls

Each interface is called via an HTTPS address, which consists of the following components:

  • The API's own domain https://api.tutkihallintoa.fi

  • The API's own ID (e.g. talous (finance))

  • The version ID of the desired API version (e.g. v1)

  • Called API operation (e.g. luvut (numbers))

  • Possible parameters in format ?{parameter 1 name}={parameter 1 value}{& parameter 2 name}={parameter 2 value}

For example, version 1 of the State Finance API, operation numbers (luvut) with the parameter main title (pääluokka) and value (arvo) 25 would be called as follows:

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