API ja API-avaimet

Trail tarjoaa avoimen rajapinnan (API), jonka avulla muut järjestelmät voivat lukea ja kirjoittaa tietoja Trailiin.

  • API-dokumentaatio löytyy osoitteesta api-doc.trail.fi.
  • Ennen kuin voit käyttää rajapintaa, API-avaimet on otettava käyttöön Trail-ympäristössäsi. Ota yhteyttä Trailin tukeen: support@trail.fi
  • API-avainten hallintaan tarvitset pääsyn Hallinta-moduuliin.
  • Trailin tuki voi tarvittaessa ottaa käyttöön asetuksen, jolla pääkäyttäjät näkevät kaikki API-avaimet (Admins Can See All Api Keys).

Aiheet:

  1. API-avaimen luominen
  2. API-avaimen lataaminen ja aktivointi
  3. API-avaimen käyttäminen

Uuden API-avaimen luominen

  1. Avaa Hallinta → API avaimet

  1. Klikkaa Luo

  1. Syötä API-avaimen tiedot
    1. Anna nimi
    2. Lisää kuvaus (valinnainen)
    3. Valitse voimassaoloaika
      1. Tämä määrittää, kuinka kauan API-avainta voi käyttää
    4. Lisää osastot, joihin API-avaimella on pääsy
      1. API-avain pääsee käsiksi vain valittuihin osastoihin
    5. Määritä API-avaimelle tarvittavat oikeudet
      1. Nämä oikeudet koskevat vain tätä API-avainta
      2. Anna vain ne oikeudet, joita integraatio tarvitsee

  1. Klikkaa Luo
  2. Lisätietoa eri käyttöoikeuksista löydät artikkelista Käyttöoikeudet selitettynä.

API-avaimen lataaminen ja aktivointi

Kun API-avain on luotu, se näkyy API Keys -listassa tilalla Inactive (ei aktiivinen).

  1. Etsi API-avain listasta
  2. Lataa avain

  1. Kun avain on ladattu, sen tila muuttuu tilaan Active (aktiivinen)

  1. API-avain on nyt valmis käytettäväksi.
  2. Säilytä ladattu API-avain turvallisesti ja jaa se vain niille henkilöille tai järjestelmille, jotka tarvitsevat pääsyn Trailin rajapintaan.

API-avaimen käyttäminen

API-dokumentaatio löytyy osoitteesta api-doc.trail.fi.