Ga naar hoofdinhoud

API-sleutels

API-sleutels verifiëren verzoeken aan de ConsentForge beheer-API. Ze zijn anders dan insluitTokens — bewaar ze geheim en gebruik ze alleen vanuit uw backend.

Een API-sleutel aanmaken

Account → API-sleutels → Sleutel aanmaken

  1. Voer een beschrijvende naam in (bijv. "Backend-synchronisatie — productie")
  2. Selecteer de scopes die uw integratie nodig heeft (minimaal benodigde)
  3. Stel een vervaldatum in (optioneel maar aanbevolen)
  4. Klik op Aanmaken

Kopieer de sleutel direct — deze wordt slechts eenmaal getoond.

Beschikbare scopes

ScopeToegang
properties:readProperties weergeven en bekijken
properties:writeProperties aanmaken en bijwerken
policies:readBeleidsregels en versies bekijken
policies:writeBeleidsregels aanmaken, publiceren, terugdraaien
receipts:readToestemmingsontvangstbevestigingen bekijken
receipts:exportOntvangstbevestigingen exporteren (grote resultaatsets)
webhooks:readWebhookconfiguratie bekijken
webhooks:writeWebhooks aanmaken en bijwerken
users:readAccountgebruikers weergeven
users:writeGebruikers uitnodigen en verwijderen
scan:triggerScans activeren via API
adminVolledige toegang — gebruik spaarzaam

Sleutelverloop

Stel een vervaldatum in om de schade te beperken als een sleutel wordt gecompromitteerd. Verlopen sleutels werken automatisch niet meer.

Roteer sleutels regelmatig. Roteren: maak een nieuwe sleutel aan → update uw integratie → verwijder de oude sleutel.

Een sleutel intrekken

Account → API-sleutels → [Sleutelnaam] → Intrekken

Intrekking is direct van kracht. Elke integratie die de sleutel gebruikt, ontvangt 401 Unauthorized-antwoorden.

Best practices voor sleutelbeveiliging

  • Bewaar sleutels in omgevingsvariabelen of een secrets-manager, nooit in broncode
  • Gebruik één sleutel per integratie (eenvoudiger om een gecompromitteerde sleutel in te trekken)
  • Gebruik de smalste scope die werkt voor uw gebruik
  • Stel een vervaldatum in voor sleutels die worden gebruikt in CI/CD-pijplijnen