Dit artikel laat je zien hoe je API-identiteiten instelt voor de Dalux Build API.
API-identiteiten bieden een manier om toegang te krijgen tot de Dalux Build API met specifieke gebruikersrechten.
Door een API-identiteit aan te maken, kun je het niveau van toegang tot het systeem specificeren, of het nu toegang tot alle bedrijfsgegevens in alle projecten betreft of beperkte toegang tot bepaalde groepen in specifieke projecten.
Als u meer wilt weten over Dalux API's, lees dit artikel: Dalux API.
Opmerking
API-identiteiten zullen de huidige functie voor API-sleutels vervangen. Let op dat alle huidige API-sleutels in het bedrijfsprofiel zullen verlopen na 28 februari 2026.
Alle API-sleutels moeten voor deze datum worden vervangen door API-identiteiten.
Hoe API-identiteiten in te stellen
API-identiteiten worden ingesteld in het bedrijfsprofiel.
Gebruikersrechten
Alleen bedrijfsbeheerders kunnen API-identiteiten instellen, bewerken of verwijderen.
Om een API-identiteit aan te maken, ga naar Bedrijfsprofiel
Instellingen
'API-identiteiten'.
In het venster API-identiteiten kun je nieuwe identiteiten aanmaken en bestaande beheren.
Je kunt meerdere identiteiten aanmaken om toegangsniveaus naar behoefte te beheren. Om een nieuwe API-identiteit aan te maken, klik op Aanmaken.
- Naam - De naam van de API-identiteit die in de interface wordt weergegeven. We raden aan een naam te kiezen die zowel beschrijvend als duidelijk is.
- Email - Het e-mailadres dat hier wordt ingevoerd, is verantwoordelijk voor het valideren van de API via een bevestigingsmail
- Bedrijf - De naam van het bedrijf waarvoor de API-identiteit is bedoeld (metadata)
- Bedrijfsrechten - Stel deze rechten alleen in wanneer de API-identiteit toegang moet hebben tot gegevens in al je projecten. De gebruikersrechten van het bedrijf komen overeen met die van de rollen in het bedrijfsprofiel (Bedrijfsbeheerder en Bedrijfswaarnemer). Dit kan worden gewijzigd nadat de identiteit is aangemaakt.
- Beschrijving - Een korte beschrijving die details bevat over de API-identiteit, zoals toegangsscope, contactinformatie of andere relevante gegevens.
Nadat je de benodigde informatie hebt verstrekt en akkoord bent gegaan met de Algemene Voorwaarden voor API-identiteiten, wordt een verificatie-e-mail gestuurd naar het e-mailadres dat je hebt opgegeven. Indien nodig kan de e-mail opnieuw worden verzonden. Je kunt geen API-sleutel genereren totdat de identiteit is geverifieerd.
Na verificatie van de API-identiteit kun je projectinstellingen toevoegen, waarmee je specifiekere projecttoegang mogelijk maakt. Deze stap is alleen nodig als je geen bedrijfstoegang hebt geselecteerd.
Klik op 'API-identiteit toevoegen' om verder te gaan. Selecteer vervolgens het project en voeg de gebruikersgroep(en) toe.
De gebruikersrechten van de geselecteerde gebruikersgroepen bepalen waar de API-identiteit toegang toe heeft in het project.
Wanneer je klaar bent, klik op 'Toevoegen'.
Nu kun je een API-sleutel toevoegen aan de API-identiteit. Klik op 'API-sleutel toevoegen' om door te gaan. Bij het toevoegen van een API-sleutel moet je de duur van de geldigheid specificeren.
Een API-sleutel wordt nu gegenereerd. Kopieer de sleutel en bevestig dat de sleutel is gekopieerd, klik dan op 'OK'.
BELANGRIJK
De API-sleutel moet worden gekopieerd en opgeslagen. Je hebt geen toegang meer tot de API-sleutel nadat het venster is gesloten.
De API-identiteit kan nu worden gebruikt met de Dalux Build API.