API Chiavi

Le chiavi API sono gestite a livello di organizzazione con controllo di accesso basato sul ruolo (RBAC). Ogni chiave può essere assegnata un ruolo organizzativo e ruoli facoltativi per applicazione, consentendo un controllo fine-granulare su cosa ogni chiave può accedere.

Dove sono gestite le chiavi API?

Naviga Impostazioni > Organizzazione > API Chiavi in console.capgo.app/impostazioni/organizzazione/api-chiavi.

La pagina mostra due sezioni:

• Chiavi RBAC — Chiavi con ruoli assegnati (consigliato). Queste chiavi utilizzano il nuovo sistema di autorizzazione basato sui ruoli.
• Chiavi Legacy — Chiavi più vecchie che utilizzano il sistema di base (read, upload, write, all) senza assegnazione di ruoli.

Come creare una nuova API chiave?

1. Clicca il ”+” tasto in alto della tabella delle chiavi RBAC.

2. Compila i informazioni della chiave:

   • Nome (obbligatorio) — Un etichetta descrittiva per la chiave (ad esempio “CI/CD Deploy”, “Monitoring Read-Only”).
   • Crea una chiave sicura (facoltativo) — Se selezionato, la chiave verrà crittografata server-side. La chiave in chiaro viene visualizzata solo una volta dopo la creazione. Non potrai recuperarla in seguito.
   • Stabilisci la data di scadenza (facoltativo) — Scegli una data dopo la quale la chiave non funzionerà più. Alcune organizzazioni impongono la scadenza obbligatoria tramite politica.

3. Seleziona un Ruolo di Organizzazione — Questo definisce le autorizzazioni di base della chiave all'interno dell'intera organizzazione. Ruoli disponibili (a seconda del proprio livello di ruolo):

   • Nessuno — Nessun accesso organizzativo; la chiave ha accesso solo agli app individuati singolarmente.
   • Membro — Accesso di lettura base all'organizzazione.
   • Amministratore — Accesso amministrativo completo all'organizzazione (eredita l'accesso a tutti gli app).

4. Se la chiave deve creare organizzazioni attraverso il pubblico API, abilita Consenti la creazione di organizzazioni.

   Aggiunge la global org.create permesso. È disponibile quando la chiave ha un ruolo di organizzazione di tipo Admin. Quando questa chiave crea una nuova organizzazione, Capgo assegna automaticamente la chiave come Super Admin su quella nuova organizzazione.

5. Se il ruolo di org selezionato non è Admin, puoi aggiungere accesso per-app:

   • Clicca ”+ Aggiungi App” per aprire il picker degli app.
   • Seleziona uno o più app, quindi assegna un ruolo a ciascuna:
     • Lettore di App — Accesso di sola lettura all'app.
     • Caricatore di App — Può caricare nuovi bundle.
     • Sviluppatore di Applicazioni — Può gestire la configurazione e le distribuzioni dell'applicazione.
     • Amministratore di Applicazioni — Accesso completo all'applicazione.

6. Clicca “Crea”.

7. Se hai selezionato “Crea chiave sicura”, si visualizzerà un modulo con la chiave in chiaro. Copiala immediatamente — non può essere recuperata dopo la chiusura del modulo.

Come gestire (modificare) una chiave API?

Clicca sul icona del cacciavite su qualsiasi chiave RBAC nella lista. Ciò apre la pagina dei dettagli della chiave dove puoi:

• Cambiare il nome della chiave Aggiornare il.
• ruolo dell'organizzazione Abilitare o disabilitare.
• Consentire la creazione di organizzazioni quando la chiave ha un ruolo di amministratore dell'organizzazione. Aggiungere, eliminare o modificare
• (Gestisci) su qualsiasi chiave RBAC nella lista. Ciò apre la pagina dei dettagli della chiave dove puoi: ruoli per-app.

Clicca “Salva modifiche” quando sei pronto.

Come regenerare una chiave API?

Per regenerare il valore segreto di una chiave API, clicca sull'icona aggiorna (Regenera) su qualsiasi chiave nella lista.

Comparirà un dialogo di conferma. Dopo aver confermato:

• Per chiavi sicure (hashate): Viene generata e visualizzata una volta in una finestra di dialogo una nuova chiave di testo. Copiatela immediatamente.
• Per chiavi di testo: Il valore della chiave viene rigenerato server-side.

Qualsiasi integrazione che utilizza il vecchio valore della chiave smetterà di funzionare immediatamente.

Come eliminare una API chiave?

Cliccare sull'icona del cestino (Elimina) su qualsiasi chiave nella lista. Confermate la cancellazione nella finestra di dialogo.

La chiave viene revocata immediatamente — qualsiasi richiesta che la utilizza fallirà.

Chiavi legacy

Se vedete chiavi nella Chiavi legacy sezione (chiavi senza assegnamenti di ruolo), queste utilizzano il sistema di autorizzazione basato sulla modalità (read, upload, write, all). Funzionano ancora, ma non beneficiano dei permessi RBAC fine-granulari.

Le chiavi legacy possono essere regenerate e cancellate dalla lista, ma non possono essere modificate per aggiungere ruoli RBAC. Consigliamo di creare nuove chiavi RBAC e cancellare le chiavi legacy quando possibile.

Se avete bisogno di gestire le chiavi legacy direttamente, potete ancora accedervi a console.capgo.app/dashboard/apikeys. Questa pagina è deprecata e verrà rimossa in un aggiornamento futuro.

Continua da API Chiavi

Se stai utilizzando API Chiavi per pianificare dashboard e API operazioni, connettilo con API Panoramica per i dettagli di implementazione in API Panoramica, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, Dispositivi per i dettagli di implementazione in dispositivi, e Bundle per i dettagli di implementazione in Bundle.