API och API nycklar

Trail har ett öppet gränssnitt som gör det möjligt för andra system att läsa och skriva resurser till Trail. Dokumentationen för det öppna gränssnittet finns här: https://api-doc.trail.fi/

För att använda gränssnittet behöver du en gränssnittsnyckel (API Token/Key).

För att aktivera API-nycklar i systemet, vänligen kontakta Trail Support: support@trail.fi och Trail Support kommer att aktivera avsnittet API-nycklar under administrationsmodulen. Se till att du har åtkomst till Management-modulen för att se avsnittet om API-nycklar:

Så här skapar du en ny API-nyckel:

Gå till Administration-modulen och välj API-nycklar. Du kommer till sidan API-nycklar där du kan se de befintliga API-nycklarna eller sparaa en ny API-nyckel genom att klicka på knappen "Spara":

När du har klickat på knappen "Spara" kommer du att se formuläret nedan "Spara en ny API-nyckel":

Du kan ge en API-nyckel ett namn och skriva en beskrivning för den. När du sparar en ny API-nyckel ska du ge API-nyckeln en giltighetsperiod. Giltighetsperioden anger hur länge API-nyckeln är giltig. Du måste också definiera avdelningar för API-nyckeln. Detta innebär att denna API-nyckel endast kan komma åt dessa angivna avdelningar, även om användaren annars har åtkomst till alla avdelningar.

När du sparar en API-nyckel ska du se till att ge API-nyckeln behörigheter till de olika modulerna. Dessa beviljade behörigheter gäller endast för API-nyckeln:

Mer information om behörigheter finns i artikeln 'Användarrättigheter': https://guide.trail.fi/article/324-anvandarrattigheter

När du har gett API-nyckeln ett namn, angett information i beskrivningen om du vill, angett en giltighetsperiod, valt avdelningar och gett behörigheter, se till att klicka på knappen "Spara" för att låta systemet skapa API-nyckeln:

När en API-nyckel har sparas visas en lista över skapade nycklar och deras status, som är "Ej i bruk":

Du kan sedan ladda ner nyckeln, varefter nyckeln blir aktiv:

Nu kan du komma åt API-nyckeln. I API-dokumentationen kan du se gränssnittstjänsterna, anropsformaten till tjänsterna och de värden som returneras av gränssnittet.