Saltare al contenuto

API Chiavi

API le chiavi 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.

Naviga a Impostazioni > Organizzazione > API Chiavi in console.capgo.app/settings/organization/api-chiavi.

La pagina visualizza 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.
pagina delle chiavi API mostrante le sezioni RBAC e Legacy
  1. Cliccare sul ”+” tasto

  2. al vertice della tabella delle chiavi RBAC. Inserire le informazioni della chiave:

    • Nome (richiesto) — Un etichetta descrittiva per la chiave (ad esempio “Deploy CI/CD”, “Leggi solo Monitoraggio”).
    • Crea 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 più recuperarla.
    • Imposta data di scadenza (facoltativo) — Scegli una data dopo la quale la chiave non funzionerà più. Alcune organizzazioni impongono la scadenza obbligatoria tramite politica.
API form di creazione della chiave con nome, opzione chiave sicura e scadenza
  1. Seleziona un Ruolo dell'organizzazione — Ciò definisce i permessi di base della chiave all'interno dell'intera organizzazione. Ruoli disponibili (a seconda del proprio livello di ruolo):

    • None – Nessuna accesso organizzativa; la chiave ha accesso solo agli app assegnati individualmente.
    • Member – Accesso di lettura base all'organizzazione.
    • Admin – Accesso amministrativo completo all'organizzazione (eredita l'accesso a tutti gli app).
  2. Se la chiave deve creare organizzazioni attraverso il pubblico API, abilita Consenti la creazione di organizzazioni.

    Questa aggiunge la possibilità globale org.create di accesso. È disponibile quando la chiave ha il ruolo di amministratore organizzativo. Quando questa chiave crea una nuova organizzazione, Capgo assegna automaticamente la chiave come Super Amministratore su quella nuova organizzazione.

  3. Se il ruolo di org selezionato non è Amministratore, puoi aggiungere l'accesso per app:

    • Clicca ”+ Aggiungi App” per aprire il picker delle app.
    • Seleziona una 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 App — Può gestire la configurazione e le distribuzioni dell'app.
      • Amministratore di App — Accesso completo all'app.
Selezione del ruolo RBAC con ruoli a livello di organizzazione e per applicazione
  1. Clicca “Crea”.

  2. Se hai selezionato “Crea chiave sicura”, un modulo visualizzerà la chiave in chiaro. Copia immediatamente – non può essere recuperata dopo la chiusura del modulo.

Modalità di chiave segreta API una volta sola con pulsante di copia

Clicca sul icona di chiave inglese (Gestisci) su qualsiasi chiave RBAC nella lista. Ciò apre la pagina dei dettagli della chiave dove puoi:

  • Cambia la chiave nome.
  • Aggiorna il ruolo dell'organizzazione Abilita o disabilita.
  • Consenti la creazione di organizzazioni quando la chiave ha il ruolo di amministratore dell'organizzazione. Aggiungi, rimuovi o cambia
  • ruoli per app Clicca.

“Salva modifiche” quando hai finito. __CAPGO_KEEP_0__

API chiave di modifica pagina con impostazioni correnti del ruolo

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

Comparirà un dialogo di conferma. Dopo aver confermato:

  • Per le chiavi sicure (hashate): Viene generata e visualizzata una nuova chiave di testo puro in una finestra modale. Copiarla immediatamente.
  • Per le chiavi pianeThe chiave di valore viene regenerata server-side.

Qualsiasi integrazione utilizzando la vecchia chiave di valore smetterà di funzionare immediatamente.

Conferma di regenerazione della chiave API

Clicca sull'icona cestino (Elimina) su qualsiasi chiave nella lista. Conferma la cancellazione nella finestra di dialogo. La chiave viene revocata immediatamente — qualsiasi richiesta che la utilizza fallirà.

Conferma di cancellazione della chiave __CAPGO_KEEP_0__

API key deletion confirmation dialog

Sottosezione intitolata “Chiavi obsolete”

Click the

Se vedete le chiavi nella sezione "Legacy Keys" (chiavi senza assegnazioni di ruolo), queste utilizzano il sistema di autorizzazione basato sulla modalità ( ). Funzionano ancora, ma non beneficiano dei permessi RBAC fine-granulari. Le chiavi legacy possono essere regenerate e eliminate dalla lista, ma non possono essere modificate per aggiungere ruoli RBAC. Raccomandiamo di creare nuove chiavi RBAC e eliminare le chiavi legacy quando possibile.read, upload, write, allSe avete bisogno di gestire le chiavi legacy direttamente, potete ancora accedervi a

console.__CAPGO_KEEP_0__.app/dashboard/apikeys

. Questa pagina è deprecata e verrà eliminata in una futura aggiornamento. Continuate da capgo ChiaviSezione intitolata “Continuate da __CAPGO_KEEP_0__ Chiavi”

Keep going from API Keys

API Chiavi

If you see keys in the API Keys per pianificare il dashboard e le 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 Pacchetti per i dettagli di implementazione in Pacchetti.