Workspace API-sleutels

✓ EnergieID voor bedrijven

Workspace API-sleutels helpen je om backendsystemen op een gecontroleerde manier te koppelen aan een specifieke Workspace. Je gebruikt ze voor automatisaties zoals data-exports, rapporteringspijplijnen of integraties die op je eigen servers draaien.

Bekijk onze algemene API-info voor meer informatie over hoe je je API-sleutel gebruikt in je backendintegratie.

Waarom Workspace API-sleutels gebruiken

Workspace API-sleutels zijn bedoeld voor veilige server-naar-serverintegraties binnen je bedrijf of energiegemeenschap.

Elke sleutel is gekoppeld aan een Workspace en kan met een toegangsniveau worden ingesteld. De beschikbare toegangsniveaus komen overeen met Workspace-rollen:

  • Lezer: alleen leestoegang
  • Bijdrager: schrijftoegang met contributor-rechten
  • Bewerker: schrijftoegang met editor-rechten

Nieuwe Workspace API-sleutels worden maar een keer getoond, op het moment van aanmaken. Bewaar de sleutelwaarde meteen in je secret manager.

Open de instellingen voor Workspace API-sleutels

  • Open de Workspace.
  • Ga naar Configuratie.
  • Open de functie API-sleutels.

Je ziet dan:

  • Een waarschuwing over veilig backendgebruik
  • Een link naar de EnergieID API-referentie
  • De huidige lijst met Workspace API-sleutels

Maak een Workspace API-sleutel aan

  • Klik op Sleutel genereren.
  • Geef een naam op, bijvoorbeeld de naam van het systeem of de integratie.
  • Kies een API-toegangsniveau:
    • Lezer: Alleen leestoegang.
    • Bijdrager: Schrijftoegang met contributor-rechten.
    • Bewerker: Schrijftoegang met editor-rechten.
  • Klik op Aanmaken.
  • Kopieer de sleutel en bewaar die veilig.

Opmerking: Voor interne (door de Workspace beheerde) dossiers kun je zowel workspace-endpoints als record-endpoints gebruiken. Externe Workspace-dossiers zijn beperkt tot workspace-endpoints.

Roteer of verwijder een sleutel

Roteer sleutels als een sleutel mogelijk is blootgesteld, wanneer teamleden vertrekken, of als onderdeel van periodiek veiligheidsbeheer.

  • Maak een nieuwe sleutel aan voor dezelfde integratie.
  • Werk je backendconfiguratie bij met de nieuwe sleutel.
  • Controleer of aanvragen nog correct werken.
  • Verwijder 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.

FAQ

Wanneer gebruik ik een Workspace API-sleutel in plaats van een persoonlijke API-sleutel?

Gebruik een Workspace API-sleutel wanneer je integratie toegang nodig heeft tot dossiers in de volledige Workspace. Persoonlijke API-sleutels geven alleen toegang tot je eigen persoonlijke dossiers, terwijl Workspace API-sleutels toegang kunnen geven tot alle dossiers in die Workspace (volgens het gekozen toegangsniveau).

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

Om veiligheidsredenen worden nieuwe sleutelwaarden maar een keer getoond bij het aanmaken. Daarna blijft alleen metadata zichtbaar.

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

Interne dossiers zijn eigendom van de Workspace en ondersteunen bredere toegang via workspace- en record-endpoints (binnen je toegangsniveau). Externe dossiers zijn gedeelde dossiers en hebben meer beperkingen.