Ga naar hoofdinhoud

API-sleutels

API-sleutels authenticeren verzoeken aan de ConsentForge-beheer-API. Ze zijn anders dan insluit-tokens — houd 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 sync — productie")
  2. Selecteer de scopes die uw integratie nodig heeft (minimaal noodzakelijk)
  3. Stel een vervaldatum in (optioneel maar aanbevolen)
  4. Klik op Aanmaken

Kopieer de sleutel onmiddellijk — hij wordt slechts één keer getoond.

Beschikbare scopes

ScopeToegang
properties:readEigenschappen weergeven en bekijken
properties:writeEigenschappen aanmaken en bijwerken
policies:readBeleidsregels en versies bekijken
policies:writeBeleidsregels aanmaken, publiceren, terugdraaien
receipts:readToestemmingsontvangstbewijzen bekijken
receipts:exportOntvangstbewijzen exporteren (grote resultaatsets)
webhooks:readWebhookconfiguratie bekijken
webhooks:writeWebhooks aanmaken en bijwerken
users:readAccountgebruikers weergeven
users:writeGebruikers uitnodigen en verwijderen
scan:triggerScans triggeren via API
adminVolledige toegang — gebruik spaarzaam

Sleutelverloop

Stel een vervaldatum in om de schade te beperken als een sleutel gecompromitteerd is. Verlopen sleutels stoppen automatisch met werken.

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

Een sleutel intrekken

Account → API-sleutels → [Sleutelnaam] → Intrekken

Intrekking is onmiddellijk. Elke integratie die de sleutel gebruikt, ontvangt 401 Unauthorized-reacties.

Best practices voor sleutelbeveiliging

  • Sla sleutels op in omgevingsvariabelen of een geheimenbeheerder, nooit in broncode
  • Gebruik één sleutel per integratie (gemakkelijker om één gecompromitteerde sleutel in te trekken)
  • Gebruik de smalste scope die werkt voor uw gebruiksscenario
  • Stel een vervaldatum in voor sleutels die in CI/CD-pipelines worden gebruikt