Registro de aplicativo OAuth 2.0

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 único e um segredo 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. No Painel do Criador, vá para a página Aplicativos OAuth 2.0.
2. Clique no botão Criar Aplicativo.
3. Insira um Nome do 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 o Segredo em um local seguro. Após fechar a página, você não terá mais acesso ao segredo e só poderá gerar um novo. Após terminar o registro de um aplicativo, você ainda pode acessar e editar as outras propriedades do aplicativo.
6. Clique em Continuar para Editar para configurar seu aplicativo, que é descrito nas seções a seguir.

Configure informações gerais

Uma vez que você tenha registrado seu aplicativo, você deve configurar suas informações gerais, incluindo:

• Uma descrição, que é visível para todos na comunidade Roblox.
• Uma imagem em miniatura para 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 homepage do site do aplicativo.
• Uma URL de Termos de Privacidade e uma URL de Termos de Serviço para que os usuários finais leiam antes de autorizar seu aplicativo. Cada URL deve ser HTTPS e não mais que 256 caracteres.

Adicione 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, deve também selecionar openid.
• Escopos de permissão específicos da API, como asset:read para a permissão de leitura de ativos. Selecione apenas o número mínimo de escopos necessários para seu aplicativo.

Adicione URLs de redirecionamento

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

• Todas as URLs de redirecionamento devem estar em uma das seguintes formas:

  • HTTPS simples, por exemplo: https://www.example.com.`
  • Caminhos em localhost com HTTP ou HTTPS (certificado autoassinado) para fins de depuração local, por exemplo:

    • `http://localhost:80``
    • `https://localhost:80``
  • Schemes 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
• O comprimento máximo de uma URL de redirecionamento é de 256 caracteres.
• Você pode adicionar até 10 URLs de redirecionamento. Com múltiplas URLs de redirecionamento, você pode ter ambientes de teste e permitir que os usuários migrem entre dois sites sem tempo de inatividade.

Envie para revisão

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

Se você quiser estender a base de usuários do seu aplicativo, você precisa publicá-lo em modo público enviando-o para revisão:

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 Revisar e Publicar. Uma mensagem com limites sobre as permissões do seu aplicativo durante o período de revisão pendente aparece.
4. Clique em Enviar para Revisão.

Enquanto a revisão do seu aplicativo está pendente, você não pode editar ou enviar outra solicitação até que a solicitação de revisão atual seja aprovada ou rejeitada. Seu aplicativo permanece em modo privado durante a revisão. Quando seu aplicativo é aprovado, ele transita para o modo público, e você não pode revertê-lo de volta para o modo privado.

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

Edite e exclua seu aplicativo

Você pode editar ou excluir seu aplicativo seguindo os passos abaixo, se não estiver sob revisão:

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

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

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

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

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