Dit artikel legt uit hoe API-identiteiten in FM kunnen worden ingesteld.
Het gebruik van een API-identiteit biedt gedetailleerde toegang tot de Dalux FM API, met gebruik van bestaande gebruikersrollen en regiologica. Hierdoor kan de API-toegang worden beperkt tot alleen de noodzakelijke gegevens.
Lees verder
Voor meer informatie over de Dalux API's, lees dit artikel: Dalux API.
Hoe API-identiteiten instellen
Technische informatie
API-identiteiten kunnen worden gebruikt voor toegang tot de Dalux FM API vanaf versie 2.0.0 en later.
API-identiteiten kunnen alleen door beheerders in de FM-instantie worden aangemaakt en beheerd.
De API-identiteit kan geen e-mail gebruiken die al is geassocieerd met een geregistreerde of uitgenodigde gebruiker in Dalux FM. Evenzo kan een e-mail voor een API-identiteit niet worden gebruikt voor een Dalux FM-gebruiker.
Om een API-identiteit aan te maken, ga naar:
Instellingen
Integraties
'API-identiteiten':
Om een nieuwe API-identiteit te maken, klik Toevoegen.
-
Identiteitstype - Je hebt twee keuzes
- Algemeen - Directe toegang tot gegevens in de FM-instantie
- Bedrijf - Toegang van externe leveranciers tot gegevens, zoals ingesteld in de bedrijfsinstellingen
- Naam - Naam van de API-identiteit (kan later worden gewijzigd)
- E-mail - E-mail gebruikt voor communicatie over Dalux API-diensten en het gebruik van de API-identiteit (kan niet worden gewijzigd zodra de API-identiteit is aangemaakt)
- Beheerder - Overschrijft de rechten van elke gebruikersrol en geeft toegang tot alle gegevens. Voor het identiteitstype 'Bedrijf' geeft het toegang tot de bedrijfsbeheerder.
- Beschrijving - Een optionele beschrijving voor de API-identiteit om jou en anderen later te helpen
Nadat je de vereiste informatie hebt ingevuld, de algemene voorwaarden hebt gelezen en geaccepteerd, klik op 'Aanmaken' om door te gaan met het instellen van de API-identiteit.
Opmerking
API-sleutels worden pas gegenereerd wanneer je ze later in het proces aan de API-identiteit toevoegt.
Je kunt nu gebruikersrollen en regio's toewijzen aan de API-identiteit. Deze bepalen welke gegevens toegankelijk zijn via de API. Je kunt bijvoorbeeld geen toegang tot werkordergegevens krijgen als de toegewezen gebruikersrollen geen toegang hebben tot werkorders.
Als de API-identiteit beheerdersrechten heeft, overschrijft deze alle rechten in de gebruikersrollen en geeft deze toegang tot alle gegevens.
Om gebruikersrollen en regio's toe te voegen aan de API-identiteit, klik op 'Toevoegen' in het gebied voor gebruikersrollen.
Je kunt gebruikersrollen op zichzelf toevoegen of ook een regio specificeren voor de gebruikersrol.
Zodra je je gebruikersrollen hebt toegevoegd, kun je API-sleutels beginnen aan te maken. Om API-sleutels voor de API-identiteit aan te maken, klik op 'Toevoegen' in het API-sleutelsgebied. Bij het aanmaken van een API-sleutel moet je de vervaltijd voor de sleutel specificeren.
Wanneer je op 'Toevoegen' klikt, wordt de API-sleutel gegenereerd.
Kopieer de sleutel en verspreid deze volgens de algemene voorwaarden. De API-identiteit kan nu zijn API-sleutel gebruiken, beperkt tot de API die is gespecificeerd door de toegangsrechten van de gebruiker.
Lees verder
Voor meer informatie over de Dalux API's, lees dit artikel: Dalux API.