Passa al contenuto principale

Chiavi API

Le chiavi API autenticano le richieste all'API di gestione di ConsentForge. Sono diverse dai token di incorporamento — tenetele segrete e usatele solo dal vostro backend.

Creare una chiave API

Account → Chiavi API → Crea Chiave

  1. Inserite un nome descrittivo (es. "Sincronizzazione backend — produzione")
  2. Selezionate gli ambiti necessari per la vostra integrazione (il minimo necessario)
  3. Impostate una data di scadenza (facoltativo ma consigliato)
  4. Cliccate su Crea

Copiate la chiave immediatamente — viene mostrata solo una volta.

Ambiti disponibili

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

Scadenza della chiave

Impostate una data di scadenza per limitare il danno potenziale se una chiave viene compromessa. Le chiavi scadute smettono di funzionare automaticamente.

Ruotate le chiavi regolarmente. Per ruotare: create una nuova chiave → aggiornate la vostra integrazione → eliminate la vecchia chiave.

Revocare una chiave

Account → Chiavi API → [Nome chiave] → Revoca

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

Migliori pratiche per la sicurezza delle chiavi

  • Memorizzate le chiavi in variabili di ambiente o in un gestore di segreti, mai nel codice sorgente
  • Usate una chiave per integrazione (più facile da revocare se una singola chiave è compromessa)
  • Usate l'ambito più ristretto che funziona per il vostro caso d'uso
  • Impostate una data di scadenza per le chiavi usate nelle pipeline CI/CD