Gestisci le chiavi API

Open Cloud autentica e autorizza l'accesso API con l'uso di chiavi API, che ti consentono di aggiungere permessi granulari e controlli di sicurezza per accedere e utilizzare determinati risorse nella tua esperienza, come depositi di dati e luoghi.

Tutte le API cloud aperte richiedono di creare una chiave API con autorizzazioni valide e includere un x-api-key Header nella tua Richiesta, che consente all'applicazione di autenticarsi su Open Cloud a tuo nome.

Crea chiavi API

Puoi creare e configurare le chiavi API per le tue esperienze di proprietà individuale o esperienze di proprietà di gruppo (un gruppo Roblox gruppo consente a più creatori di lavorare sullo stesso esperienza, utilizzare gli stessi risorse e condividere le chiavi API).

Devi essere il proprietario del gruppo o essere assegnato a un ruolo all'interno del gruppo che abbia l'autorizzazione API key admin per creare una chiave API per il tuo Gruppo.Un membro del gruppo può creare una chiave API solo con le stesse autorizzazioni di accesso alla risorsa del loro ruolo.Ad esempio, solo i membri del gruppo con l'autorizzazione Crea e modifica esperienze di gruppo possono creare una chiave API che può pubblicare un file di posizione.

Per creare una chiave API:

Naviga alla Dashboard del Creatore.
(Opzionale) Fai clic sul menu a discesa Creator Hub per selezionare un gruppo se stai creando la chiave API per un Gruppo.
Nel menu di navigazione a sinistra, seleziona Apri cloud → Chiavi API .
Fai clic sul pulsante Crea chiave API .
Inserisci un nome univoco per la chiave API.Usa un nome che ti possa aiutare a ricordare lo scopo in seguito, come PLACE_PUBLISHING_KEY per i luoghi di pubblicazione alla tua esperienza.
Nella sezione Permessi di accesso , seleziona un'API dal menu Seleziona sistema API e clicca il pulsante Aggiungi sistema API .Ripeti questo passaggio se devi aggiungere più API alla chiave.
Seleziona l'esperienza a cui vuoi accedere con la chiave API.
Dalla casella a discesa Operazioni di esperienza , seleziona le operazioni che vuoi abilitare per la chiave API.

Molte operazioni nell'API reference includono gli scopi di autorizzazione richiesti.Ad esempio, l'operazione scarica memoria store richiede l'autorizzazione ].

Per motivi di sicurezza, assegna a ciascuna chiave API il numero minimo di permessi richiesti.Se una chiave API si perde, questo principio di minimo privilegio garantisce che solo un sottinsieme delle tue risorse sia compromesso.
Nella sezione Sicurezza , imposta esplicitamente l'accesso IP alla chiave utilizzando notazione CIDR, altrimenti non puoi utilizzare la chiave API.Puoi trovare l'indirizzo IP della tua macchina locale e aggiungerlo alla sezione Indirizzi IP accettati insieme ad altri indirizzi IP per quelli che hanno bisogno di Accesso.Se non hai un fisso, o stai usando la chiave API solo in un Ambientelocale, puoi semplicemente aggiungere 0.0.0.0/0 alla sezione Indirizzi IP accettati per consentire a qualsiasi IP di utilizzare la tua chiave API.
(Opzionale) : Per aggiungere una protezione supplementare per le tue risorse, imposta una data di scadenza esplicita in modo che la tua chiave smetta di funzionare dopo quella data.
Fai clic sul pulsante Salva e genera la chiave .
Copia e salva la stringa della chiave API in una posizione sicura che non è un repository pubblico del tuo codice .
Controlla la chiave API creata sulla pagina Estensioni API di Dashboard del creatore .

La stringa della chiave API è equivalente alla password della tua applicazione.Non condividilo mai con parti non affidabili, come chiunque al di fuori del tuo team di sviluppo.

Permessi della chiave API di proprietà del gruppo

I proprietari di gruppo possono gestire i permessi della chiave API di proprietà del gruppo per i membri del gruppo di avere diversi livelli di controllo delle chiavi API in base ai ruoli e alle autorizzazioni interno al Gruppo.Ci sono anche situazioni in cui viene revocata automaticamente la gestione delle chiavi API per i membri del gruppo.

Permessi di concessione

Come proprietario di gruppo, puoi concedere l'autorizzazione Gestisci tutte le chiavi API ai ruoli all'interno del tuo Gruppo.I membri con questo permesso hanno tutte le autorizzazioni che un proprietario di gruppo ha per le chiavi API, inclusa la possibilità di creare, vista, modificare, Revocaree auditare tutte le chiavi API del Gruppo.

Puoi anche concedere l'autorizzazione Gestisci le chiavi API proprie ai ruoli all'interno del tuo Gruppo.Questo consente ai membri di creare e visualizzare solo le chiavi di loro proprietà piuttosto che essere in grado di gestire le chiavi di altri.

Validazione delle autorizzazioni

Ci sono diverse situazioni in cui viene revocata automaticamente l'autorizzazione di un Membridel gruppo a gestire le chiavi API del gruppo:

Il membro viene assegnato a un ruolo diverso che non ha il permesso. Questo può accadere durante un trasferimento della proprietà del gruppo.
L'autorizzazione del Membriè disabilitata sul ruolo attualmente assegnato.
Il membro esce o viene rimosso dal Gruppo.
L'account del Membriè sotto moderazione da Roblox.

In uno di questi casi, le chiavi API generate da quell'utente ricevono lo stato Revoked .Per utilizzare nuovamente queste chiavi, il proprietario del gruppo o un membro con l'autorizzazione Gestisci tutte le chiavi API deve rigenerare le chiavi.

Formato CIDR

Per proteggere ulteriormente le tue risorse, quando crei una chiave API, specifica gli indirizzi IP che possono accedere alla chiave API con indirizzi IP normali o utilizzando la notazione CIDR.Un indirizzo IP CIDR sembra un indirizzo IP normale, tranne che termina con uno slash e un decimale che rappresenta quanti bit dell'indirizzo IP sono rilevanti per il routing di rete:

Normale : 192.168.0.0
CIDR : 192.168.0.0/24

La parte precedente è l'indirizzo IP e la parte successiva è il netmask , che conta i bit di 1s in formato binario.Nell'esempio precedente, 24 significa 255.255.255.0 (24 1s) che consente tutti gli IP tra 192.168.0.0 e 192.168.0.255 .Capire il formato CIDR è particolarmente utile se si prevede di eseguire le applicazioni su un Server.

Stato della chiave API

Le chiavi API inizialmente hanno uno Statoattivo, ma possono diventare inattive nel corso della loro vita.Per capire perché una chiave API ha cambiato stato e come restituire la chiave API a uno Statoattivo, vedi la seguente tabella.

Se tu o il tuo gruppo non utilizzate o non aggiornate una chiave API per 60 giorni, scade automaticamente, anche se non ha una data di scadenza impostata.Questo riduce il rischio che gli attori cattivi utilizzino vecchie chiavi API.Se non stai più utilizzando una chiave API, dovresti disabilitarla o eliminarla manualmente.

Stato	Motivo	Risoluzione
Attivo	Nessun problema. L'utente può utilizzare la chiave per autenticare le chiamate API.	N/A
Disabilitato	L'utente ha disabilitato la chiave disabilitando l'opzione Abilita chiave.	Abilita il pulsante Abilita tasto attivare/disattivare.
Scaduto	La data di scadenza della chiave è passata.	Rimuovi o imposta una nuova data di scadenza.
Scaduto automaticamente	L'utente non ha utilizzato o aggiornato la chiave negli ultimi 60 giorni.	Puoi disabilitare quindi abilitare l'attivare/disattivareAttiva chiave, oppure puoi aggiornare qualsiasi proprietà della chiave, come il nome, la Descrizioneo la data di scadenza.
Revocato	Solo per le chiavi di gruppo. L'account che ha generato la chiave non ha più il permesso di accesso sufficiente per gestire le chiavi del Gruppo.	Fai clic sul Regenera Chiave per ottenere un nuovo segreto.
Moderato	Un amministratore di Roblox ha cambiato il segreto della chiave per motivi di sicurezza.	Fai clic sul Regenera Chiave per ottenere un nuovo segreto.
Utente moderato	L'account che ha generato la chiave è sotto moderazione da Roblox.	Risolvi il problema di moderazione sull'Account.