• +0504122470
  • helpdesk@tamk.fi

Rajapinnat

Käyttö

Tarvitset ensimmäiseksi API-avaimen, jolla saat käyttöoikeuden rajapintoihin.

Rajapintoja kutsutaan käyttämällä HTTPS-protokollaa sekä GET- tai POST-metodia kohteesta riippuen. Hakuehdot annetaan JSON-muodossa POST-kutsuissa sekä polussa tai url-parametrina GET-kutsuissa. Rajapintojen osoitteet ovat muotoa https://opendata.tamk.fi/<versio>/<rajapinta>. Toistaiseksi on olemassa vain yksi versio.

Rajapintoja voi kokeilla esimerkiksi SoapUI:n (graafinen ohjelma) ja cURL:n avulla. Varsinaista ohjelmointia voi tehdä millä tahansa kielellä, joka tukee REST-rajapintoihin tehtäviä kyselyjä ja JSON-datan käsittelyä (Java, PHP, C#, …).

Kieleistys

Voit valita sisällön kielen antamalla halutun kielen otsikkotiedoissa tai kutsuparametrina. Oletuskieli on suomi (fi). Voit pyytää sisällön myös englanniksi (en). Kaikesta sisällöstä ei kuitenkaan välttämättä ole käännöstä olemassa.

Esimerkki otsikkotiedoissa:

curl -u "<API-avain>:" -H "Accept-Language: en" https://opendata.tamk.fi/r1/reservation/180733

Esimerkki kutsuparametrissa ’l’ (pieni L-kirjain):

curl -u "<API-avain>:" https://opendata.tamk.fi/r1/reservation/180733?l=en

Jos molemmat on annettu, niin kutsuparametri yliajaa otsikkotiedoissa asetetun.

Päivämäärät

Päivämäärän muoto JSON:ssa on aina ”yyyy-MM-dd’T’HH:mm”, ellei muuta ole rajapinnan yhteydessä mainittu. Esimerkiksi ”2014-10-22T13:30”.

Tunnistautuminen

Rajapintoihin tunnistaudutaan HTTP Basic Auth -menetelmällä, jossa API-avain on käyttäjänimi ja salasana on tyhjä.

Esimerkiksi cURL:a käytettäessä voidaan käyttäjänimi antaa ’u’-parametrilla. Kaksoispiste käyttäjänimen perässä estää sitä pyytämästä salasanaa.

curl -u "<API-avain>:" https://opendata.tamk.fi/r1/reservation/180733

Käytettävissä olevat tiedot

Linkkiä klikkaamalla aukeaa kunkin rajapinnan kuvaus. Kuvauksen lopussa on myös esimerkkihaku kyseisellä rajapinnalla.