API-identiteter i Dalux Build API

Denne artikkelen viser deg hvordan du setter opp API-identiteter for Dalux Build API.

API-identiteter gir tilgang til Dalux Build API med spesifikke brukerrettigheter.

Ved å opprette en API-identitet, kan du spesifisere tilgangsnivået til systemet, enten det er tilgang til alle firmaopplysninger på alle prosjekter, eller begrenset tilgang til visse grupper på spesifikke prosjekter.

Hvis du vil lære mer om Dalux API-er, les denne artikkelen: Dalux API.

Hvordan sette opp API-identiteter

API-identiteter settes opp i firmaprofilen.

For å opprette en API-identitet, gå til Firmaprofil Innstillinger 'API-identiteter'.

I API-identiteter-vinduet kan du opprette nye identiteter og administrere eksisterende.

Du kan opprette flere identiteter for å administrere tilgangsnivåer etter behov. For å sette opp en ny API-identitet, klikk på Opprett.

• Navn - Navnet på API-identiteten som vises i grensesnittet. Vi foreslår at du velger et navn som er både beskrivende og tydelig.
• Epost - E-posten som er oppgitt her er ansvarlig for å validere API-en via en bekreftelsesepost
• Firma - Navnet på firmaet som API-identiteten er for (metadata)
• Firmarettigheter - Angi bare denne brukerrettigheten når API-identiteten skal ha tilgang til data på tvers av alle prosjektene dine. Firmarettighetene samsvarer med rollene i firmaprofilen (Firmaadministrator og Firmaobservatør). Dette kan endres etter at identiteten er opprettet.
• Beskrivelse - En kort beskrivelse som inkluderer detaljer om API-identiteten, som tilgangsområde, kontaktinfo eller andre relevante opplysninger.

Når du har oppgitt nødvendig informasjon og godkjent vilkårene og betingelsene for API-identiteten, vil en bekreftelsesepost bli sendt til e-postadressen du oppga. Om nødvendig kan e-posten sendes på nytt. Du kan ikke generere en API-nøkkel før identiteten er verifisert.

Etter at API-identiteten er verifisert, kan du legge til prosjektinnstillinger, som gir mer spesifikk tilgang til prosjekter. Denne handlingen er kun nødvendig hvis du ikke har valgt noen firmatilgang.

Klikk på 'Legg til prosjekt' for å fortsette. Deretter velger du prosjektet og legger til brukergruppen(e).

De valgte brukergruppenes rettigheter styrer hva API-identiteten har tilgang til på prosjektet.

Når du er ferdig, klikk 'Legg til'.

Nå kan du legge til en API-nøkkel til API-identiteten. Klikk på 'Legg til API-nøkkel' for å fortsette. Når du legger til en API-nøkkel, må du angi gyldighetsperioden.

En API-nøkkel vil nå bli generert. Kopier nøkkelen og bekreft at nøkkelen er kopiert, og klikk deretter 'OK'.

API-identiteten kan nå brukes med Dalux Build API.