Denne artikel vil forklare, hvordan du opsætter API-identiteter i FM.
Brug af en API-identitet tillader granular adgang til Dalux FM API, ved brug af eksisterende brugerroller og regionslogik. Dette tillader, at API-adgang er begrænset til kun de nødvendige data.
Læs mere
For mere information om Dalux API, læs denne artikel: Dalux API.
Sådan opsætter du API-identiteter
Teknisk information
API-identiteter kan bruges til adgang til Dalux FM API fra version 2.0.0 og senere.
API-identiteter kan kun oprettes og administreres af administratorer i FM-instansen.
API-identiteten kan ikke bruge en e-mail, der allerede er forbundet med en registreret eller inviteret bruger i Dalux FM. Tilsvarende kan en e-mail til en API-identitet ikke bruges af en Dalux FM bruger.
For at oprette en API-identitet, gå til:
Indstillinger
Integrationer
'API-identiteter':
For at oprette en ny API-identitet, klik Tilføj.
-
Identitetstype - Du har to valgmuligheder
- Generel - Direkte adgang til data i FM-instansen
- Firma - Ekstern leverandøradgang til data, som opsat i firmainstillingerne
- Navn - Navn på API-identiteten (kan ændres senere)
- E-mail - E-mail brugt til kommunikation vedrørende Dalux API-tjenester og brugen af API-identiteten (kan ikke ændres når API-identiteten er oprettet)
- Administrator - Overskriver enhver brugerrolles tilladelser og giver adgang til alle data. For identitetstypen 'Firma' giver det firmaadministrator adgang.
- Beskrivelse - En valgfri beskrivelse for API-identiteten til at hjælpe dig og andre senere
Når de nødvendige oplysninger er indtastet, og betingelserne og vilkårene er læst og accepteret, klik 'Opret' for at fortsætte opsætningen af API-identiteten.
Bemærk
API-nøgler genereres ikke, før du tilføjer dem til API-identiteten senere i processen.
Du kan nu tildele brugerroller og regioner til API-identiteten. Disse bestemmer, hvilke data der er tilgængelige via API'en. For eksempel kan du ikke få adgang til opgaver, hvis de tildelte brugerroller ikke har adgang til opgaver.
Hvis API-identiteten har administratorrettigheder, overskrider det alle tilladelser i brugerrollerne og giver adgang til alle data.
For at tilføje brugerroller og regioner til API-identiteten, klik på 'Tilføj' i brugerrolleområdet.
Du kan tilføje brugerroller alene, eller også angive en region for brugerrollen.
Når du har tilføjet dine brugerroller, kan du begynde at oprette API-nøgler. For at oprette API-nøgler til API-identiteten, klik på 'Tilføj' i API-nøgleområdet. Når du opretter en API-nøgle, skal du angive udløbstiden for nøglen.
Når du klikker på 'Tilføj', genereres API-nøglen.
Kopier nøglen og distribuer den i overensstemmelse med betingelserne. API-identiteten kan nu bruge sin API-nøgle, begrænset til API'en specificeret af brugerens rolle.
Læs mere
For mere information om Dalux API, læs denne artikel: Dalux API.