API ja API-avaimet

Traililla on avoin rajapinta, jonka avulla muut järjestelmät voivat lukea ja kirjoittaa Trailiin resursseja. Avoimen rajapinnan dokumentaation pystyy näkemään täältä: https://apidoc.trail.fi/

Rajapinnan käyttöä varten tarvitaan rajapinta-avain (API Token/Key).

Voidaaksesi ottaa API-avaimet käyttöön järjestelmässä otathan yhteyttä Trailin tukeen: support@trail.fi jolloin Trailin tuki aktivoi API-avaimet -osion Hallinta-moduulin alle. Varmistathan, että sinulla on pääsy Hallinta-moduuliin, jotta pääset näkemään Api-avaimet osion:

Näin luot uuden API-avaimen:

Mene Hallinta-moduuliin ja sieltä valitse API-avaimet. Saat auki API-avaimet sivun, missä näkee olemassaolevat API-avaimet tai voit luoda uuden API-avaimen klikkaamalla 'Luo' painiketta:

Klikattuasi 'Luo' painiketta näet alla olevan lomakkeen 'Luo uusi API-avain':

Voit antaa API-avaimelle nimen ja kirjoittaa sille kuvausta. Luodessa uuden API-avaimen, anna API-avaimelle voimassaoloaika. Voimassaoloaika kertoo kuinka kauan kyseinen API-avain on voimassa. API-avaimelle on määriteltävä myös osastot. Tämä tarkoittaa sitä, että kyseisellä API-avaimella pääsee vain näihin määriteltyihin osastoihin vaikka käyttäjällä olisi käyttöoikeuksissaan pääsy kaikkiin osastoihin muuten.

Luodessaan API-avaimen, muista antaa API-avaimelle oikeudet eri moduuleihin. Nämä annetut oikeudet koskevat vain API-avainta:

Lisää oikeuksista 'Käyttäjäoikeudet' artikkelissa: https://opas.trail.fi/article/226-kayttooikeudet

Kun olet antanut API-avaimelle nimen, halutessasi kirjoittanut tietoja kuvaukseen, antanut voimassaoloajan, valinnut osastot sekä antanut oikeudet, muista klikata sen jälkeen 'Luo' painiketta, jotta järjestelmä pystyy luomaan API-avaimen:

Kun API-avain on luotu, näet listauksessa luodun avaimen ja sen tilan, joka on 'Ei käytössä':

Voit tämän jälkeen ladata avaimen, jonka jälkeen avain muuttuu aktiiviseksi:

Nyt pääset käyttämään API-avainta. API dokumentaatiosta näet rajapinnan palvelut, palveluille tehtävien kutsujen muodot, sekä rajapinnan palauttamat arvot.