Gerenciando Chaves da API

O Open Cloud autentica e autoriza o acesso à API com o uso de chaves de API, o que permite que você adicione permissões granulares e controle de segurança para acessar e utilizar certos recursos em sua experiência, como armazenamentos de dados e locais.

Todas as APIs abertas exigem que você crie uma chave de API com permissões válidas e inclua um cabeçalho x-api-key em sua solicitar / pedir, o que permite que a aplicação seja autenticada no Open Cloud em seu nome.

Criando Chaves da API

Você pode criar e configurar chaves de API para suas experiências individualmente-possuídas ou experiências de propriedade do grupo (um Roblox grupo permite que vários criadores trabalhem na mesma experiência, usem os mesmos recursos e compartilhem chaves de API).

Você deve ser o proprietário do grupo ou designado para um papel dentro do grupo que tenha a permissão de administrador de chave da API para criar uma chave API para seu grupo. Um membro do grupo só pode criar uma chave API com as mesmas permissões de acesso de recursos de seu papel. Por exemplo, apenas membros do grupo com a permissão Criar e editar experiências de grupo podem criar uma chave que pode publicar um arquivo de local.

Para criar uma chave API:

1. Navegue até o Painel do Criador.

2. (Opcional) Clique no menu suspenso Hub de Criador para selecionar um grupo se você estiver criando a chave de API para um grupo.

3. No menu de navegação à esquerda, selecione Abrir Nuvem → Chaves da API.

4. Clique no botão Criar Chave da API .

5. Insira um nome único para a sua chave API. Use um nome que possa ajudá-lo a lembrar o propósito mais tarde, como PLACE_PUBLISHING_KEY para publicar locais na sua experiência.

6. Na seção Permissões de Acesso , selecione uma API a partir do menu Selecionar Sistema de API e clique no botão Adicionar Sistema de API . Repita esse passo se você precisar adicionar várias APIs à chave.

7. Selecione a experiência que você deseja acessar com a chave API.

8. Do menu suspenso Operações de Experiência , selecione as operações que você deseja habilitar para a chave API.

   Muitas operações na <a href="/reference/api-reference">API reference</a> incluem os scopes de permissão necessários. Por exemplo, a operação <a href="/reference/api-reference">flush memory store</a> requer o permissão <a href>universo.Memory-store:flush</a>.

   Por razões de segurança, dê a cada chave de API o número mínimo de permissões necessárias. Se uma chave de API vazar, esse princípio de menor privilégio garante que apenas um subconjunto de seus recursos seja comprometido.

9. Na seção Segurança, configure o acesso IP usando notação CIDR, caso contrário, você não pode usar a chave da API. Você pode encontrar o endereço IP de sua ambientelocal e adicioná-

10. (Opcional) : Para adicionar proteção adicional para seus recursos, configure uma data de expiração explícita para que sua chave pare de funcionar automaticamente após essa data.

11. Clique no botão Salvar e Gerar chave .

12. Copie e salve a string da chave da API para um local seguro que não seja um repositório público de seu código.

13. Verifique sua chave API criada na página Credenciais do Painel do Criador .

Permissões de API de propriedade do grupo

Os proprietários do grupo podem gerenciar as permissões de chave de API de propriedade do grupo para os membros do grupo terem diferentes níveis de controle de chaves de API com base nas funções e permissões dentro do grupo. Existem também situações que automaticamente revogam permissões de gerenciamento de chave de API para membros do grupo.

Gerenciando Permissões

Como um Proprietáriode grupo, você pode conceder a permissão Gerenciar todas as chaves da API a papéis dentro do seu grupo. Membros com essa permissão têm todas as permissões que um proprietário de grupo tem para as chaves da API, incluindo a capacidade de Criar, ver, editar, remover / revogare auditar todas as chaves da API do grupo.

Você também pode conceder a permissão Gerenciar suas próprias chaves de API a papéis dentro do seu grupo. Isso permite que os membros criem e visualizem apenas as chaves de propriedade deles, em vez de poderem gerenciar as chaves de outros.

Permissões inválidas

Existem várias situações que automaticamente revogam a permissão de um membrosdo grupo para gerenciar as chaves da API do grupo:

• O membro é atribuído a um diferente papel que não tem permissão. Isso pode ocorrer durante uma transferência de propriedade do grupo.
• A permissão do membrosé desativada no papel atribuído atualmente.
• O membro sai ou é removido do grupo.
• A conta do membrosestá em moderação pelo Roblox.

Em qualquer um desses casos, as chaves da API geradas por esse usuário são dadas o status de Revogido e Status. Para usar essas chaves novamente, o proprietário do grupo ou um membro com a permissão Gerenciar todas as chaves da API deve regenerar as chaves.

Formato CIDR

Para proteger melhor seus recursos, quando criar uma chave de API, especifique endereços IP que podem acessar a chave da API com qualquer endereço IP normal ou usando a notação CIDR. Um endereço IP CIDR parece um endereço IP normal, exceto que termina com um ponto e um dígito que representa o número de bits da endereço IP:

• Normal : 192.168.0.0
• CIDR : 192.168.0.0/24

A parte anterior é o endereço IP e a parte superior é a net mask , contando os bits de 1s em formato servidor. No exemplo anterior, 24 significa 255.255.255.0 (24 1s

Status da Chave da API

As chaves da API inicialmente têm um status ativo, mas elas podem ficar inativas ao longo de sua vida útil. Para aprender por que uma chave da API mudou o status e como retornar a chave da API ao status ativo, veja a tabela a seguir.