Denne artikkelen vil forklare hvordan man setter opp API-identiteter i FM.
Ved å bruke en API-identitet, tillates granulert tilgang til Dalux FM API ved å bruke eksisterende brukerroller og regionlogikk. Dette tillater at API-tilgang kan være begrenset til kun de nødvendige dataene.
Les mer
For mer informasjon om Dalux API-er, les denne artikkelen: Dalux API.
Hvordan sette opp API-identiteter
Teknisk informasjon
API-identiteter kan brukes til tilgang til Dalux FM API fra versjon 2.0.0 og senere.
API-identiteter kan kun opprettes og håndteres av administratorer i FM-instansen.
API-identiteten kan ikke bruke en e-post som allerede er tilknyttet en registrert eller invitert bruker i Dalux FM. Tilsvarende kan en e-post for en API-identitet ikke brukes for en Dalux FM-bruker.
For å opprette en API-identitet, gå til:
Innstillinger
Integrasjoner
'API-identiteter':
For å opprette en ny API-identitet, klikk Tilføy.
-
Identitetstype - Du har to valg
- Generell - Direkte tilgang til data i FM-instansen
- Firma - Ekstern leverandørtilgang til data, slik det er satt opp i firmaets innstillinger
- Navn - Navn på API-identiteten (kan endres senere)
- E-post - E-post brukes for kommunikasjon angående Dalux API-tjenester og bruk av API-identiteten (kan ikke endres når API-identiteten er opprettet)
- Administrator - Overstyrer enhver brukerrolles tillatelse og gir tilgang til alle data. For 'Firma' identitetstype, gir det firmaadministrator tilgang.
- Beskrivelse - En valgfri beskrivelse for API-identiteten for å hjelpe deg og andre senere
Etter at du har fylt inn den nødvendige informasjonen, lest og akseptert vilkårene og betingelsene, klikker du på 'Opprett' for å fortsette oppsettet av API-identiteten.
Notat
API-nøkler genereres ikke før du legger dem til API-identiteten på et senere tidspunkt i prosessen.
Du kan nå tilordne brukerroller og regioner til API-identiteten. Disse bestemmer hvilke data som er tilgjengelige via API. For eksempel kan du ikke få tilgang til arbeidsordredata hvis de tildelte brukerrollene ikke har tilgang til arbeidsordrer.
Hvis API-identiteten har administratorrettigheter, overstyrer det alle tillatelser i brukerrollene og gir tilgang til alle data.
For å legge til brukerroller og regioner til API-identiteten, klikker du på 'Tilføy' i området for brukerroller.
Du kan legge til brukerroller alene, eller også angi en region for brukerrollen.
Når du har lagt til dine brukerroller, kan du begynne å opprette API-nøkler. For å opprette API-nøkler for API-identiteten, klikker du på 'Tilføy' i området for API-nøkler. Når du oppretter en API-nøkkel, må du angi utløpstid for nøkkelen.
Når du klikker på 'Tilføy', vil API-nøkkelen bli generert.
Kopier nøkkelen og distribuer den i henhold til vilkårene og betingelsene. API-identiteten kan nå bruke sin API-nøkkel, begrenset til API-et som er spesifisert av brukerens rolletilgang.
Les mer
For mer informasjon om Dalux API-ene, les denne artikkelen: Dalux API.