Registro de aplicativo do OAuth 2.0

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Registrar seu aplicativo OAuth 2.0 permite que ele acesse recursos do Roblox.Após o registro, o Roblox atribui ao aplicativo um ID de cliente exclusivo e secreto que você pode usar para obter autorização dos usuários para acessar suas informações e recursos do Roblox.

Registre seu aplicativo

Para registrar um aplicativo:

  1. Clique no botão Criar Aplicativo OAuth 2.0 .
  2. Insira um nome de aplicativo válido e globalmente único Nome de aplicativo .
  3. Leia e concorde com os Termos de Serviço do Roblox e clique em Criar .
  4. Copie e armazene o ID do Cliente e Segredo em um local seguro.Depois de fechar a página, você não tem mais acesso ao segredo e só pode gerar um novo.Depois de terminar de registrar um aplicativo, você ainda pode acessar e editar outras propriedades do aplicativo.
  5. Clique em Continuar a Editar para configurar seu aplicativo, que é descrito nas seções a seguir.

Configurar informações gerais

Uma vez que você registrou seu aplicativo, você deve configurar sua informação geral, incluindo:

  • Uma descrição, que é visível para todos na comunidade Roblox.
  • Uma imagem de miniatura para o seu aplicativo. O tamanho de arquivo recomendado é de pelo menos 150x150 pixels.
  • Um Link de Entrada como o ponto de entrada do seu aplicativo, como a página inicial do site do aplicativo.
  • Um URL de Termos de Privacidade e um URL de Termos de Serviço para leitura por usuários finais antes de autorizar seu aplicativo.Cada URL deve ser HTTPS e não mais de 256 caracteres.

Adicionar permissões

Para garantir o controle de acesso e segurança adequados dentro do seu aplicativo, você deve adicionar Escopos de Permissão .Existem dois tipos de escopos de permissão disponíveis:

  • Escopos de identidade para autenticação, como openid para IDs de usuário e profile para os perfis completos.Se você selecionar o escopo profile , você também deve selecionar openid .
  • Escopos de permissão específicos da API , como asset:read para a permissão de leitura de recursos.Selecione apenas o número mínimo de alcances que você precisa para o seu aplicativo.

Adicionar URLs de redirecionamento

Redirecionar URLs são os pontos de reentrada do seu aplicativo para os quais os usuários são redirecionados quando terminam de autorizar seu aplicativo.Certifique-se de que seus URLs de redirecionamento atendam aos seguintes requisitos:

  • Todos os URLs de redirecionamento devem estar em um dos seguintes formatos:
    • HTTPS simples, por exemplo: https://www.example.com .
    • Caminhos no localhost com HTTP ou HTTPS (certificado assinado por si mesmo) para fins de depuração locais, por exemplo:
      • http://localhost:80
      • https://localhost:80
    • Esquemas personalizados para aplicações ou fins específicos, por exemplo:
      • my-app-scheme:/
      • my-app-scheme://foo/bar/...
      • my-app://action?param1=value1&param2=value2
  • O comprimento máximo de uma URL de redirecionamento é 256 caracteres.
  • Você pode adicionar até 10 URLs de redirecionamento.Com vários URLs de redirecionamento, você pode ter ambientes de teste e permitir que os usuários migrem entre dois sites sem tempo de inatividade.

Enviar para avaliar

Para minimizar as chances de aplicativos maliciosos prejudicarem a comunidade, registrar um aplicativo não o torna amplamente acessível.Em vez disso, permanece em modo privado com um limite de 10 usuários únicos.Este modo é útil para testar e depurar dentro de sua Equipe.

Se você quiser expandir a base de usuários para o seu aplicativo, precisa publicá-lo no modo público ao enviá-lo para avaliar:

  1. Vá para a página Aplicativos OAuth 2.0.
  2. Clique no botão Editar e Publicar para o aplicativo que você deseja publicar.
  3. Preencha todas as informações necessárias e clique no botão Revisão e Publicação .Uma mensagem com limites nas permissões do seu aplicativo durante o período de revisão pendente aparece.
  4. Clique em Enviar para Revisão .

Enquanto sua revisão de app está pendente, você não pode editar ou enviar outro pedido até que o pedido de revisão atual seja aprovado ou rejeitado.Seu aplicativo permanece no modo privado durante a avaliar.Quando seu app é aprovado, ele transita para o modo público e você não pode revertê-lo para o modo privado.

Independentemente de se o seu aplicativo for aprovado ou rejeitado, você recebe uma notificação por e-mail do resultado quando a revisão for concluída.

Edite e exclua seu aplicativo

Você pode editar ou excluir seu aplicativo com os seguintes passos se ele não estiver em avaliar:

  1. Vá para a página Aplicativos OAuth 2.0.

  2. Clique em Editar ou Excluir para o aplicativo desejado.

    • Se você optou por editar um aplicativo, siga os mesmos passos e requisitos de registro.
    • Se você optou por excluir um aplicativo, clique em Sim, Excluir para confirmar a exclusão. Depois de excluir um aplicativo, você não pode recuperá-lo.

Modificar a informação geral do seu aplicativo ou os URLs de redirecionamento não requer que os usuários reautorizem o aplicativo.No entanto, se você adicionar ou modificar os escopos de permissão, deve obter autorização para as novas permissões de seus usuários e adquirir um novo conjunto de tokens.Se você não obter autorização para os novos escopos, seu aplicativo pode continuar usando os tokens existentes, mas está limitado aos escopos anteriores.

Para apps no modo privado, o sistema atualiza automaticamente suas edições com seus usuários.Para aplicativos no modo público, você deve enviar o aplicativo para revisão novamente para refletir essas alterações.Caso contrário, o sistema salva as alterações não publicadas para você sem liberá-las para a comunidade.