Siirry sisältöön
Fingrid Avoin data kotisivu

fi

en

API-ohjeet

Fingridin avoin data -palvelun tietoaineistoja voi ladata koneluettavassa muodossa avoimen REST API ohjelmointirajapinnan kautta. Fingrid haluaa tarjota kaikille avoimen datan käyttäjille tasavertaista palvelua ja kehittää verkkopalvelua käyttäjien palautteen perusteella. Tämän vuoksi Fingridin ohjelmointirajapintojen käyttö vaatii API-avaimen.

Palvelun käytettävyys ja huoltokatkot

  • Rekisteröinnin yhteydessä kannattaa tilata sähköposti-ilmoitukset, jotta voimme tiedottaa mahdollisista rajapinnan käyttöön liittyvistä muutoksista tai muista käyttöön vaikuttavista asioista.
  • Huoltokatkoista pyrimme tiedottamaan erikseen. Huoltokatkotieto välittyy myös API:n kautta huoltokatkojen aikana.
  • Pyrimme tarjoamaan oikeaa ja ajanmukaista tietoa, mutta Fingrid Oyj ei takaa että tiedot olisivat kattavia ja virheettömiä. Yksittäisissä tietoaineistoissa voi olla virheellisiä tai puuttuvia arvoja lähdejärjestelmistä johtuen.

Rajapinnan käyttö

  • Ohjelmointirajapintojen käyttö on maksutonta ja rekisteröitymiseen riittää toimiva sähköpostiosoite.
  • Rekisteröityneille käyttäjille voidaan myös käyttäjän suostumuksella lähettää sähköpostia rajapinnan käyttöön liittyvistä muutoksista tai muista käyttöön vaikuttavista asioista.
  • Voit halutessasi myös poistaa rekisteröimäsi tunnuksen.

API-avain

API-avaimen saa rekisteröitymällä palvelun käyttäjäksi ja hyväksymällä palvelun käyttöehdot. Kirjautunut käyttäjä voi itse hallita API-avaimiaan Kehittäjäportaalin kautta

  1. Kirjaudu tai rekisteröidy Avoimen datan palveluun

  2. Siirry Hallintapaneelin kautta kehittäjäportaaliin

  3. Kirjaudu Kehittäjäportaaliin painamalla Sign in. Jos olet jo kirjautuneena Avoimen datan palveluun, sinun ei tarvitse antaa tunnuksiasi uudelleen.

  4. Kirjauduttuasi palveluun pääset tekemään API-tilauksen kohdasta Products

  5. Valitse Open Data starter, kirjoita tilaukselle nimi ja paina Subscibe.

  6. API-tilauksesi sekä API-avaimesi näet sivulta Profile. Voit milloin tahansa luoda avaimet uudelleen.

API-kutsujen tekeminen

Ohjeita ja esimerkkejä API-käyttöön löydät kehittäjäportaalista.

Rajapinta vastaa seuraavasta osoitteesta: https://data.fingrid.fi/api

Rajapinnan kutsuminen edellyttää API-avainta, joka tulee lisätä HTTP-kutsun header-kenttään x-api-key. Saat omat API-avaimesi rekisteröitymällä kehittäportaaliin yllä olevien ohjeiden mukaisesti.

Lisäohjeet:

  • Avainta ei tule käyttää esimerkiksi selaimen URL-osoiterivillä. Jos haet dataa suoraan johonkin sovellukseen, voit tyypillisesti määritellä sovelluksessasi API:n URL-osoitteen yhteyteen muita parametrejä ja sijoittaa avaimen siihen.
  • Rajapinnan kautta voi hakea tietoaineistojen tietoja ja metatietoja.
  • API kutsuissa määritellään haluttu tietoaineisto datasetId -muuttujalla. Jokaisen tietoaineiston yksilöllinen muuttujan ID löytyy tietoaineiston kuvauksesta.
  • Palvelussa on API-avainkohtaisia hakumäärärajoitteita: yhdellä API-avaimella saa tehdä palveluun enintään 10 000 kyselyä vuorokaudessa ja kymmenen hakua minuutissa. Mikäli tarvitset laajempia käyttöoikeuksia, ota yhteyttä palvelun ylläpitäjään.
  • Tietoaineistojen päivitysväli vaihtelee. Päivitysväli on ilmoitettu tietoaineiston kuvauksessa. Kolmen minuutin välein päivittyvät arvot ovat hetkellisiä mittaustietoja, joiden alku- ja päättymisaika on sama. Aikasarjadatasta saattaa joskus puuttua yksittäisiä mittaustietoja teknisistä syistä johtuen.
  • Huomioi Cross Origin Resource Sharing (CORS) -rajoitukset käyttäessäsi rajapintaa selainympäristössä.