Gerenciar chaves da API

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

Todas as APIs de nuvem abertas exigem que você crie uma chave de API com permissões válidas e incluam um cabeçalho x-api-key na sua solicitar / pedir, o que permite que o aplicativo se autentique no Open Cloud em seu nome.

Criar chaves de API

Você pode criar e configurar chaves de API para suas experiências de propriedade individual ou experiências de propriedade do grupo (um grupo 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 da API para o seu grupo.Um membro do grupo só pode criar uma chave de API com as mesmas permissões de acesso a recursos de seu papel.Por exemplo, apenas membros de grupo com a permissão Criar e editar experiências de grupo podem criar uma chave de API que possa publicar um arquivo de local.

Para criar uma chave de API:

Navegue até o Painel do Criador.
(Opcional) Clique no menu suspenso Hub do Criador para selecionar um grupo se você estiver criando a chave da API para um grupo.
No menu de navegação à esquerda, selecione Abrir Nuvem → Chaves de API .
Clique no botão Criar Chave da API .
Insira um nome único para a chave da API.Use um nome que possa ajudá-lo a lembrar do propósito mais tarde, como PLACE_PUBLISHING_KEY para publicar locais para sua experiência.
Na seção Permissões de Acesso , selecione uma API no menu Selecionar Sistema de API e clique no botão Adicionar Sistema de API .Repita este passo se precisar adicionar várias APIs à chave.
Selecione a experiência que você deseja acessar com a chave da API.
Na caixa de seleção Operações de Experiência , selecione as operações que você deseja habilitar para a chave da API.

Muitas operações na referência da API incluem os escopos de permissão necessários.Por exemplo, a operação limpar armazenamento de memória requer a permissão universe.memory-store:flush.

Por razões de segurança, dê a cada chave da 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.
Na seção Segurança , defina explicitamente o acesso IP à chave 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 máquina local e adicioná-lo à seção Endereços IP Aceitos junto com endereços IP adicionais para aqueles que precisam de acesso.Se você não tiver um IP fixo, ou estiver usando a chave da API apenas em um ambiente local, você pode adicionar 0.0.0.0/0 à seção Endereços IP Aceitos para permitir que quaisquer IPs usem sua chave da API.
(Opcional) : Para adicionar uma proteção adicional aos seus recursos, defina uma data de expiração explícita para que sua chave pare de funcionar após essa data.
Clique no botão Salvar e Gerar chave .
Copie e salve a string de chave da API em um local seguro que não seja um repositório público de seu código .
Verifique a chave de API criada na página Extensões de API do Painel do Criador .

A string de chave da API é equivalente à senha de sua aplicação.Nunca compartilhe-o com partes não confiáveis, como qualquer pessoa fora de sua Equipedesenvolvimento.

Permissões de chave da API de propriedade do grupo

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

Permissões concedidas

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

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

Invalidação de permissões

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

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

Em qualquer um desses casos, as chaves da API geradas por esse usuário recebem o status Revogado .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 ainda mais seus recursos, ao criar uma chave de API , especifique endereços IP que possam acessar a chave de API com endereços IP normais ou usando a notação CIDR.Um endereço IP CIDR parece um endereço IP normal, exceto que termina com um traço e um decimal que representa quantos bits do endereço IP são significativos para a roteabilidade de rede:

Normal : 192.168.0.0
CIDR : 192.168.0.0/24

A parte anterior é o endereço IP e a parte posterior é o netmask , contando os bits de 1s no formato binário.No exemplo anterior, 24 significa 255.255.255.0 (24 1s) que permite todas as IPs entre 192.168.0.0 e 192.168.0.255 .Entender o formato CIDR é particularmente útil se você planeja executar suas aplicações em um servidor.

statusda chave da API

As chaves da API inicialmente têm um status ativo, mas podem se tornar inativas ao longo de sua vida útil.Para saber por que uma chave de API mudou de status e como devolver a chave de API de volta a um status ativo, veja a tabela a seguir.

Se você ou seu grupo não usar ou atualizar uma chave de API por 60 dias, ela expira automaticamente, mesmo que não tenha uma data de expiração definida.Isso reduz o risco de atores maliciosos usando chaves de API antigas.Se você não estiver mais usando uma chave de API, você deve desativá-la ou excluí-la manualmente.

Estatus	Motivo	Resolução
Ativo	Sem problemas. O usuário pode usar a chave para autenticar chamadas de API.	N/A
Desativado	O usuário desativou a chave desabilitando a opção Ativar Chave.	Ative a opção Ativar Tecla alternar.
Expirado	A data de expiração da chave expirou.	Ou remova ou defina uma nova data de expiração.
Expirado Automaticamente	O usuário não usou ou atualizou a chave nos últimos 60 dias.	Você pode desativar e ativar então a opção Ativar Chave, ou você pode atualizar qualquer uma das propriedades da chave, como o nome, a descrição ou a data de expiração.
Revogado	Apenas para chaves de grupo. A conta que gerou a chave já não tem permissão de acesso suficiente para gerenciar as chaves do grupo.	Clique no Regenerar Chave para obter um novo segredo.
Moderado	Um administrador do Roblox mudou o segredo da chave por motivos de segurança.	Clique no Regenerar Chave para obter um novo segredo.
Usuário Moderado	A conta que gerou a chave está sob moderação pelo Roblox.	Resolva o problema de moderação na conta.