Den här artikeln kommer att förklara hur du ställer in API-identiteter i FM.
Att använda en API-identitet möjliggör granulär åtkomst till Dalux FM API, med hjälp av befintliga användarroller och regionslogik. Detta möjliggör att API-åtkomst begränsas till endast nödvändiga data.
Läs mer
För mer information om Dalux API:er, läs den här artikeln: Dalux API.
Hur man ställer in API-identiteter
Teknisk information
API-identiteter kan användas för åtkomst till Dalux FM API från version 2.0.0 och senare.
API-identiteter kan endast skapas och hanteras av administratörer i FM-instansen.
API-identiteten kan inte använda en e-postadress som redan är kopplad till en registrerad eller inbjuden användare i Dalux FM. På samma sätt kan en e-postadress för en API-identitet inte användas för en Dalux FM-användare.
För att skapa en API-identitet, gå till:
Inställningar
Integrationer
'API-identiteter':
För att skapa en ny API-identitet, klicka Lägg till.
-
Identitetstyp - Du har två val
- Allmän - Direkt åtkomst till data i FM-instansen
- Företag - Extern leverantörsåtkomst till data, enligt hur det har konfigurerats i företagsinställningarna
- Namn - Namn på API-identiteten (kan ändras senare)
- E-post - E-post som används för kommunikation angående Dalux API-tjänster och användningen av API-identiteten (kan inte ändras när API-identiteten har skapats)
- Administratör - Skriver över alla användarrollers rättigheter och ger åtkomst till all data. För identitetstypen 'Företag' ger den åtkomst som företagsadministratör.
- Beskrivning - En valfri beskrivning för API-identiteten för att hjälpa dig och andra senare
När du har fyllt i den obligatoriska informationen, läst och accepterat villkoren, klickar du på 'Skapa' för att fortsätta konfigurera API-identiteten.
Observera
API-nycklar genereras inte förrän du lägger till dem i API-identiteten senare i processen.
Du kan nu tilldela användarroller och regioner till API-identiteten. Dessa avgör vilka data som är åtkomliga via API:et Till exempel kan du inte komma åt arbetsorderdata om de tilldelade användarrollerna inte har åtkomst till arbetsorder.
Om API-identiteten har administratörsrättigheter, skriver den över alla rättigheter i användarrollerna och ger åtkomst till all data.
För att lägga till användarroller och regioner till API-identiteten, klicka på 'Lägg till' i användarrollområdet.
Du kan lägga till användarroller på egen hand, eller också specificera en region för användarrollen.
När du har lagt till dina användarroller, kan du börja skapa API-nycklar. För att skapa API-nycklar för API-identiteten, klicka på 'Lägg till' i området för API-nycklar. När du skapar en API-nyckel måste du ange giltighetstiden för nyckeln.
När du klickar 'Lägg till', kommer API-nyckeln att genereras.
Kopiera nyckeln och distribuera den enligt villkoren och bestämmelserna. API-identiteten kan nu använda sin API-nyckel, begränsad till API:et som anges av användarens rollåtkomst.
Läs mer
För mer information om Dalux API:er, läs den här artikeln: Dalux API.