REST rajapinnat

Yleistä

Rajapintoja kutsutaan käyttämällä GET ja POST metodeja riippuen kohteesta. Mahdolliset parametrit annetaan aina JSON muodossa POST kutsuissa.

Huomaa että koodi-esimerkit saattavat näkyä rivitettynä selaimessa. Jos maalaat alueen (tai tuplaklikkaat aluetta) niin saat kopioitua tiedot oikein rivitettynä.

Kieleistys

Voit valita sisällön kielen (kieleistetyt kentät) antamalla halutun kielen otsikkotiedoissa tai "query parametrina". Oletuskieli on suomi (fi). Vaihtoehtoisesti voit pyytää sisällön kielellä englanti (en)

Esimerkiksi:

# Otsikkotiedoissa
curl -u "oma_api_key:" -H "Accept-Language: en" http://opendata.metropolia.fi/r1/reservation/816121
 
# Query parametrina "l". Jos molemmat annettu niin query parametri yliajaa otsikkotiedoissa asetetun.
curl -u "oma_api_key:" http://opendata.metropolia.fi/r1/reservation/816121?l=en

Päivämäärät

Päivämäärän muoto JSON:ssa on aina "yyyy-MM-dd'T'HH:mm" ellei muuta mainittu. Esimerkiksi "2020-12-31T13:30".

Autentikointi

Kaikkien kutsujen autentikointi toteutetaan antamalla API-key Basic Auth otsikkotiedoissa (api-key on käyttäjänimi, salasana on tyhjä. Muista ":" merkki käyttäjänimen jälkeen kun asetat otsikkotiedon arvon). Esimerkiksi curl käytettäessä voidaan käyttäjänimi antaa "-u" parametrilla. Kaksoispiste käyttäjänimen perässä estää curl:a pyytämästä salasanaa.

curl -u "oma_api_key:" http://opendata.metropolia.fi/r1/reservation/816121