Palvelun rajapintakäyttö

Avoindata-palvelun käyttäminen API:n kautta

Avoimen tiedon (datan) tuottajilla on usein tarve hakea ja päivittää tietoaineistoja tai niitä kuvaavia metatietoja säännöllisesti. Kun tiedot ovat valmiina tietojärjestelmässä, kannattaa toistuvat rutiinit automatisoida palvelun rajapintojen avulla.

Avoindata-palvelu sisältää REST/JSON-rajapinnat, joiden päälle nykyiset käyttöliittymät on rakennettu. Kaikki Avoindata-palvelussa olevat tiedot on saatavilla rajapintojen avulla.

Palvelun tavoite on, että mahdollisimman moni avoimen datan tuottaja julkaisisi automaattisesti päivittyvät tiedot palvelun rajapintojen avulla. Automaattiset päivitykset pitävät tiedot paremmin ajan tasalla, datan laatu nousee ja hyödyllisyys kasvaa.

Metatietojen ja tietoaineistojen hakeminen rajapinnan kautta

Alle on koottu joidenkin esimerkkikyselyjen vastauksia. Tietoaineistojen ja metatietojen hakemiseen et tarvitse API-tokenia.

Huom! On hyvä tietää, että jos haet rajapinnan kautta tietoa esimerkiksi Excel-muotoisesta aineistoista, joka koostuu useasta välilehdestä, voi rajapinnan kautta hakea vain Excelin ensimmäisen välilehden tiedot.

API-tokenit

Jos haluat muokata tai lisätä tietoja rajapintojen avulla, tarvitset API-tokenin. Alta löydät ohjeet API-tokenin luomiseen Avoindata-palvelussa.

 

  1. Kirjaudu sisään palveluun. Jos sinulla ei ole vielä käyttäjätunnusta, rekisteröidy ensin palveluun.​​
  2. Valitse sivun yläreunasta oma käyttäjätunnuksesi (tässä esimerkissä se on "testikäyttäjä").

    Pääset omalle profiilisivullesi valitsemalla käyttäjänimesi.
     
     

API-token

Saat luotua API-tokenin seuraamalla alla olevia ohjeita.

1. Navigoi omaan profiiliisi ja valitse API-tokenit välilehti luodaksesi API-tokenin.

API-token luodaan omassa profiilissa API tokenit -välilehdellä.

2. Anna tokenille nimi ja valitse Luo API token.API-tokenille annetaan ensin nimi, jonka jälkeen painetaan Luo API token -painiketta.

3. Sivun yläreunaan tulee ilmoitus, josta voit kopioida oman API-token koodisi. Ota koodi talteen, sillä sitä ei saa palautettua, jos kadotat sen, vaan sinun täytyy luoda uusi token.

API-tokenit välilehdellä voit poistaa ja luoda uusia tokeneita. Poistaminen lopettaa tokenin toiminnan.

JSON selaimessa

JSON (JavaScript Object Notation) on yksinkertainen avoimen standardin dataformaatti tiedonvälitykseen. Nimestään huolimatta se on JavaScript-ohjelmointikielestä riippumaton.

JSON-dataformaatti ei aina näytä internet-selaimessa selkeältä. Selaimiin on kuitenkin saatavilla erilaisia laajennuksia, jotka muotoilevat sen ihmiselle helpommin luettavaa muotoon.

Selainlaajennoksia JSON:n muotoiluun

Alla on esimerkki oikein muotoillusta JSON-dataformaatista, josta ihmisen on helppo erottaa tietosisältö.
Esimerkki muotoillusta JSON-dataformaatista, josta ihmisen on helppo erottaa tietosisältö.