Passa al contenuto principale

Chiavi API

Le chiavi API autenticano le richieste all'API di gestione ConsentForge. Sono diverse dai token di integrazione — tienile segrete e usale solo dal tuo backend.

Creare una chiave API

Account → Chiavi API → Crea chiave

  1. Inserisci un nome descrittivo (es. "Sync backend — produzione")
  2. Seleziona gli scope necessari per la tua integrazione (il minimo necessario)
  3. Imposta una data di scadenza (opzionale ma consigliata)
  4. Clicca Crea

Copia la chiave immediatamente — viene mostrata solo una volta.

Scope disponibili

ScopeAccesso
properties:readElenca e visualizza proprietà
properties:writeCrea e aggiorna proprietà
policies:readVisualizza policy e versioni
policies:writeCrea, pubblica, ripristina policy
receipts:readVisualizza ricevute di consenso
receipts:exportEsporta ricevute (set di risultati di grandi dimensioni)
webhooks:readVisualizza configurazione webhook
webhooks:writeCrea e aggiorna webhook
users:readElenca utenti account
users:writeInvita e rimuovi utenti
scan:triggerAttiva scansioni tramite API
adminAccesso completo — usa con parsimonia

Scadenza chiave

Imposta una data di scadenza per limitare i danni in caso di compromissione di una chiave. Le chiavi scadute smettono di funzionare automaticamente.

Ruota le chiavi regolarmente. Per ruotare: crea una nuova chiave → aggiorna la tua integrazione → elimina la chiave vecchia.

Revocare una chiave

Account → Chiavi API → [Nome chiave] → Revoca

La revoca è immediata. Qualsiasi integrazione che usa la chiave inizierà a ricevere risposte 401 Unauthorized.

Best practice per la sicurezza delle chiavi

  • Conserva le chiavi in variabili d'ambiente o in un gestore di segreti, mai nel codice sorgente
  • Usa una chiave per integrazione (più facile revocare una singola chiave compromessa)
  • Usa lo scope più ristretto che funziona per il tuo caso d'uso
  • Imposta una data di scadenza per le chiavi usate nelle pipeline CI/CD