Registro de App 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. Depois do 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.

Registrando seu aplicativo

Para registrar um aplicativo:

  1. Na Painel do Criador, vá para a página OAuth 2.0 Apps.
  2. Clique no botão Criar Aplicativo OAuth 2.0 .
  3. Insira um Nome de Aplicativo válido e globalmente único.
  4. Leia e concorde com os Termos de Serviço do Roblox e clique em Criar .
  5. Copie e armazene o ID do Cliente e Secreto em um localseguro. Depois de fechar a página, você não tem mais acesso ao secreto e só pode gerar um novo. Depois de registrar um aplicativo, você ainda pode acessar e editar as outras propriedades do aplicativo.
  6. Clique em Continuar Edição para configurar sua aplicativo, que está descrito nas seções a seguir.

Configurando Geral Informação

Uma vez que você registrou sua aplicativo, você deve configurar suas informações gerais, incluindo:

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

Adicionando Permissões

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

  • Esconder escopos de identificação para autenticação, como openid para IDs de usuário e profile para perfis completos. Se você selecionar o escopo de 0> perfil0>, você também deve selecionar 3> openid 3>.
  • Espectros 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 escopos que você precisa para o seu aplicativo.

Adicionando URLs de Redirecionamento

Redirecionar URLs são os pontos de reentrada de sua aplicação que os usuários são redirecionados quando terminam de autorizar sua aplicativo. Certifique-se de que suas re direcionar URLs atendem aos seguintes requisitos:

  • Todos os URLs de redirecionamento devem estar em uma das seguintes formas:
    • Plain HTTPS, por exemplo: https://www.example.com .
    • Caminhos em localhost com HTTP ou HTTPS (certificado de autossinistro) para fins de depuração local, por exemplo:
      • http://localhost:80
      • https://localhost:80
    • Esquemas personalizados para aplicações ou propósitos específicos, por exemplo:
      • my-app-scheme:/
      • my-app-scheme://foo/bar/...
      • my-app://action?param1=value1&param2=value2
  • A máxima comprimento de uma URL de redirecionamento é 256 caracteres.
  • Você pode adicionar até 10 URLs de redirecionamento. Com múltiplos URLs de redirecionamento, você pode ter ambientes de teste e permitir que os usuários migrem entre dois sites sem tempo de inatividade.

Enviando para Revisão

Para minimizar as chances de aplicativos maliciosos prejudicar a comunidade, registrar um aplicativo não o torna acessível publicamente. Em vez disso, ele permanece em modo privado com um limite de 100 usuários autorizados. Este modo é útil para testes e diagnósticos dentro de sua Equipe.

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

  1. Vá para a página OAuth 2.0 Apps.
  2. Clique no botão Editar e Publicar para a aplicação que você deseja publicar.
  3. Preencha toda a informação necessária e clique no botão Revisão e Publicação . Uma mensagem com limites nas permissões do seu aplicativo durante a 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 a solicitação de revisão atual seja aprovada ou rejeitada. Seu app permanece no modo privado durante a avaliar. Quando seu app for aprovado, ele se tornará público e você não poderá reverter para o modo privado.

Independentemente de aprovar ou rejeitar seu aplicativo, você recebe uma notificação de e-mail do resultado quando a revisão é concluída.

Editando e Excluindo seu App

Você pode editar ou excluir seu aplicativo com as seguintes etapas se não estiver em avaliar:

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

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

    • Se você escolher editar um aplicativo, siga os mesmos passos e requisitos de registro .
    • Se você escolher 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 redirecionar URLs não requer que os usuários reautorizem o aplicativo. No entanto, se você adicionar ou modificar escopos de permissão, você deve obter autorização dos novos permissões dos seus usuários e adquirir um novo conjunto de tokens. Se você não obter autorização para os novos scopes, seu aplicativo pode continuar usando os tokens existentes, mas está limitado aos scopes anteriores.

Para aplicações no modo privado, o sistema atualiza automaticamente suas edições com seus usuários. Para aplicações no modo público, você deve enviar a aplicação 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.