Gestire le chiavi API

Open Cloud autorizza e autorizza l'accesso API con l'uso di chiavi API, che ti consente di aggiungere autorizzazioni granulari e controlli di sicurezza per l'accesso e l'utilizzo di risorse specifiche nella tua esperienza, come archivi di dati e luoghi.

Tutte le API Open Cloud richiedono che tu crei una chiave API con autorizzazioni valide e includa un x-api-key header nella tua Richiesta, che consente all'applicazione di autenticarsi su Open Cloud in tuo nome.

Creazione di chiavi API

Puoi creare e configurare le API per le tue esperienze di proprietà individuale o esperienze di proprietà del gruppo (un gruppo Roblox ti consente di lavorare sullo stesso esperienza, utilizzare le stesse risorse e condividere le chiavi API).

Devi essere il proprietario del gruppo o essere assegnato a un ruolo all'interno del gruppo che ha l'autorizzazione API Key Admin per creare una chiave API per il tuo Gruppo. Un membro del gruppo può creare solo una chiave API con le stesse autorizzazioni di accesso del 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 luogo.

Per creare una chiave API:

1. Vai alla Dashboard del Creatore .

2. (Facoltativo) Fai clic sulla casella di selezione Creazione Hub del Creatore per selezionare un gruppo se stai creando la chiave API per un Gruppo.

3. Nel menu di navigazione a sinistra, seleziona Apri Cloud → Chiavi API.

4. Fai clic sul pulsante Crea chiave API .

5. Inserisci un nome unico per la tua chiave API. Usa un nome che ti possa aiutare a ricordare il scopo in seguito, come PLACE_PUBLISHING_KEY per la pubblicazione dei luoghi nella tua esperienza.

6. Nella sezione Permessi di accesso, seleziona un API dal menu Seleziona sistema API e fai clic sul pulsante Aggiungi sistema API. Ripeti questo passo se hai bisogno di aggiungere più API alla chiave.

7. Seleziona l'esperienza a cui accedere con la chiave API.

8. Dall' Esperienza Operazioni menu a discesa, seleziona le operazioni che vuoi abilitare per la chiave API.

   Molte operazioni nella API reference includono gli script di autorizzazione richiesti. Ad esempio, l'operazione flush memory store richiede l'autorizzazione universe.memory-store:flush.

   Per motivi di sicurezza, assegnare a ciascuna chiave API il numero minimo di autorizzazioni richieste. Se una chiave API fuoriesce, questo principio di autorizzazione minima garantisce che solo un sottoinsieme delle tue risorse sia compromesso.

9. Nella sezione Sicurezza, imposta in modo esplicito l'accesso IP all'area di lavoro utilizzando CIDR;, altrimenti non puoi usare la chiave API. Puoi trovare l'indirizzo ​della

10. (Facoltativo) : Per aggiungere una protezione aggiuntiva per le tue risorse, imposta una data di scadenza esplicita in modo che la tua chiave smetta di funzionare dopo quella data.

11. Click the Salva e genera la chiave button.

12. Copia e salva la chiave API a un luogo sicuro che non sia no un deposito pubblico del tuo codice.

13. Controlla la tua chiave API creata nella pagina Credenziali di Creator Dashboard .

Autorizzazioni API di proprietà del gruppo

I proprietari del gruppo possono gestire le autorizzazioni API di proprietà del gruppo per i membri del gruppo avere diversi livelli di controllo delle chiavi API in base ai ruoli e alle autorizzazioni all'interno del Gruppo. Ci sono anche situazioni che revocano automaticamente le autorizzazioni API di proprietà del gruppo.

Permessi di concessione

Come proprietario di un gruppo, puoi concedere il permesso Gestisci tutte le chiavi API a 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, tra cui la capacità di creare, vista, Modificare, Revocaree audit tutte le chiavi API del Gruppo.

Puoi anche concedere il permesso Gestisci le chiavi API della propria API a ruoli all'interno del tuo Gruppo. Ciò consente ai membri di creare e visualizzare le chiavi di proprietà loro piuttosto che essere in grado di gestire le chiavi di altri.

Permessi non validi

Ci sono diverse situazioni in cui il permesso di un Membridel gruppo revocato automaticamente il permesso di gestire le chiavi API del gruppo:

• Il membro è assegnato a un ruolo diverso che non ha l'autorizzazione. Questo può accadere durante un trasferimento della proprietà del gruppo.
• La autorizzazione del Membriè disabilitata nel ruolo attualmente assegnato.
• Il membro lascia o viene rimosso dal Gruppo.
• L'account del Membriè in moderazione da Roblox.

In uno qualsiasi di questi casi, le chiavi API generate da quell'utente sono assegnate lo stato Revoked keys . Per utilizzare queste chiavi nuovamente, il proprietario del gruppo o un membro con l'autorizzazione Gestisci tutte le chiavi API deve generare 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 qualsiasi indirizzo IP normale o utilizzando la notazione CIDR. Un indirizzo IP CIDR sembra un indirizzo IP normale ad eccezione che termina con un trattino e un decimo che rappresenta il numero di bit dell'indirizzo IP:

• Normale : 192.168.0.0
• CIDR : 192.168.0.0/24

La parte precedente è l'indirizzo IP e la parte successiva è la net mask , che conta i bit di 1s in formato binario. Nel precedente esempio, 24 significa 255.255.255.0

Stato della chiave API

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