API-sleutels voor workspaces

Met API-sleutels koppel je externe systemen, rapportagetools of automatiseringspijplijnen rechtstreeks aan je EnergieID workspace. Zo wissel je veilig en geautomatiseerd gegevens uit met je eigen servers of software.

Bekijk onze algemene API-documentatie voor meer informatie over hoe je je API-sleutel gebruikt in je backend-integratie.

Waarom API-sleutels gebruiken?

API-sleutels zijn ideaal voor betrouwbare en doorlopende backend-integraties binnen je organisatie. Omdat de sleutels zijn gekoppeld aan de workspace en niet aan een individueel persoon, blijven ze gewoon actief, zelfs wanneer de maker de organisatie verlaat.

Elke sleutel heeft een eigen toegangsniveau dat overeenkomt met de workspace-rollen:

• Lezer: alleen leestoegang.

• Bijdrager: schrijftoegang met contributor-rechten.

• Bewerker: schrijftoegang met editor-rechten.

Let op: Voor interne dossiers krijgt de remote app toegang tot gedetailleerde dossier- en metergegevens. Voor externe dossiers is de toegang beperkt tot gegevens die beschikbaar zijn in de workspace. 

Een API-sleutel aanmaken

Nieuwe API-sleutels worden slechts één keer getoond op het moment van aanmaken. Bewaar de sleutelwaarde meteen in een veilige secret manager.

• Open de workspace en ga naar Configuratie.

• Open de functie API-sleutels.

• Klik op Sleutel genereren.

• Geef een duidelijke naam op (bijvoorbeeld de naam van het externe systeem of de integratie).

• Kies het gewenste API-toegangsniveau (Lezer, Bijdrager of Bewerker).

• Klik op Aanmaken en kopieer de sleutel onmiddellijk.

Roteer of verwijder een sleutel

Roteer sleutels als een sleutel mogelijk is blootgesteld, wanneer teamleden de organisatie verlaten, of als vast onderdeel van je periodieke veiligheidsbeheer. Maak eenvoudig een nieuwe sleutel aan voor dezelfde integratie en verwijder pas na aanpassing van je remote process de oude sleutel.

Veiligheidsaanbevelingen

• Bewaar sleutels in een secret manager, nooit in broncode.
• Gebruik aparte sleutels per omgeving en per integratie.
• Kies het laagste toegangsniveau dat je integratie nodig heeft.
• Roteer sleutels periodiek en na incidenten.
• Log sleutelgebruik waar mogelijk in je eigen backend.

Veelgestelde vragen

Wat gebeurt er met de API-sleutel als de maker de organisatie verlaat?

De sleutel blijft gewoon actief. Omdat deze API-sleutels gekoppeld zijn aan de workspace en niet aan een individuele gebruiker, blijven je integraties en back-endsystemen ononderbroken doorwerken.

Kan ik dezelfde API-sleutel voor meerdere workspaces gebruiken?

Nee, een API-sleutel wordt per workspace aangemaakt. Dit zorgt voor een veilige scheiding van toegangsrechten per project of organisatieonderdeel.

Wat is het verschil met een persoonlijke API-sleutel?

Workspace-sleutels zijn bedoeld voor automatische achtergrondprocessen en server-integraties op workspace-niveau. Persoonlijke API-sleutels zijn gekoppeld aan een individueel gebruikersaccount en geven uitsluitend toegang tot jouw persoonlijke dossiers, los van de workspace-dossiers.

Waarom kan ik de volledige sleutelwaarde niet meer zien in de lijst?

Om veiligheidsredenen toont EnergieID de geheime sleutel slechts één keer (bij het aanmaken). Daarna wordt de sleutel om redenen van beveiliging niet meer weergegeven.

Wat is het verschil tussen interne en externe workspace-dossiers voor API-toegang?

Interne dossiers bieden uitgebreidere toegang via zowel de algemene workspace-endpoints als specifieke record-endpoints. Externe dossiers zijn beperkt en kunnen enkel worden aangesproken via de workspace-endpoints.