Inledning #

Genom Api tillgång till systemet kan man komma åt alla delar av systemet som användarens grupp kan komma åt. Dessa tillgångar styrs via gruppens rättigheter.

Vi rekommenderar att ni skapar en dedikerad grupp och användare för just Api tillgång så att man kan enkelt ta bort tillgång till systemet ifall så skulle behövas.

Hämta Api nyckel #

Api nyckeln som används för tillgång är en JWT token som finns att hämta på “ANVÄNDARE” -> Redigera användare -> Tabben “API ÅTKOMST

Klicka på kopiera ikonen för att kopiera JWT token. Detta är en Refresh token.

Anropa Api #

Använd den URL som gäller för er instans där användaren har tillgång som domän, sedan vilken REST tjänst ni vill anropa. Logga in i systemet med en användare och läs om tillgängliga tjänster på sidan “API: Dokumentation“.

Autentifiering #

Använd
POST /api/v3/user/refresh-token
Body: { refresh_token: ‘JWT token som ni kopierade’ }

Svar 201:
{
token: ‘access token’,
refresh_token: ‘ny refresh token’
}

Om annat svar än 201 kunde åtgärden inte slutföras.

Använd nästkommande anrop till Api med den token som returnerades.

När något Api anrop returnerar 401 behöver access token förnyas, med samma anrop som ovan med er refresh token.

Anrop #

Med Access token från refresh-token anropet kan ni nu komma åt de tjänster som finns aktiverade för gruppen som användaren tillhör.

För att kunna komma åt alla tjänster krävs det att man satt en så kallad “Bearer” token i headern “Authorization”

Header = {
Authorization: “Bearer ey…..”
}

Denna bearer måste vara svaret från “refresh-token” med värdet “token”, alltså access-token. Denna token kommer att till sluta fungera efter en kortare tid, därför är det viktigt att när 401 svar sker att ni då gör en ny access-token genom “refresh-token” tjänsten.

Hur upplever du artikeln
Updated on 2024-01-24