Enregistrement d'application OAuth 2.0

L'enregistrement de votre application OAuth 2.0 lui permet d'accéder aux ressources Roblox. Après l'enregistrement, Roblox attribue à l'application un identifiant client unique et un secret que vous pouvez utiliser pour obtenir l'autorisation des utilisateurs d'accéder à leurs informations et ressources Roblox.

Enregistrez votre application

Pour enregistrer une application :

1. Dans le Tableau de bord des créateurs, allez à la page Applications OAuth 2.0.
2. Cliquez sur le bouton Créer une application.
3. Entrez un Nom d'application valide et globalement unique.
4. Lisez et acceptez les Conditions d'utilisation de Roblox et cliquez sur Créer.
5. Copiez et conservez l'Identifiant client et le Secret dans un endroit sûr. Après avoir fermé la page, vous n'aurez plus accès au secret et ne pourrez en générer un nouveau. Après avoir terminé l'enregistrement d'une application, vous pouvez toujours accéder et modifier les autres propriétés de l'application.
6. Cliquez sur Continuer à modifier pour configurer votre application, ce qui est décrit dans les sections suivantes.

Configurez les informations générales

Une fois que vous avez enregistré votre application, vous devez configurer ses informations générales, y compris :

• Une description, qui est visible par tous dans la communauté Roblox.
• Une image miniature pour votre application. La taille de fichier recommandée est d'au moins 150x150 pixels.
• Un Lien d'entrée comme point d'entrée de votre application, tel que la page d'accueil du site web de l'application.
• Une URL des conditions de confidentialité et une URL des conditions d'utilisation pour que les utilisateurs finaux puissent les lire avant d'autoriser votre application. Chaque URL doit être en HTTPS et ne pas dépasser 256 caractères.

Ajoutez des autorisations

Pour garantir un contrôle d'accès approprié et la sécurité au sein de votre application, vous devez ajouter des Scopes d'autorisation. Il existe deux types de scopes d'autorisation disponibles :

• Scopes d'identité pour l'authentification, tels que openid pour les identifiants d'utilisateur et profile pour les profils complets. Si vous sélectionnez le scope profile, vous devez également sélectionner openid.
• Scopes d'autorisation spécifiques à l'API, tels que asset:read pour la permission de lecture des actifs. Sélectionnez uniquement le nombre minimum de scopes dont vous avez besoin pour votre application.

Ajoutez des URL de redirection

Les URL de redirection sont les points de réentrée de votre application vers lesquels les utilisateurs sont redirigés lorsqu'ils ont terminé d'autoriser votre application. Assurez-vous que vos URL de redirection répondent aux exigences suivantes :

• Toutes les URL de redirection doivent être sous l'une des formes suivantes :

  • HTTPS simple, par exemple : https://www.example.com.`
  • Chemins sur localhost avec HTTP ou HTTPS (certificat auto-signé) pour des fins de débogage local, par exemple :

    • http://localhost:80
    • https://localhost:80
  • Schémas personnalisés pour des applications ou des fins spécifiques, par exemple :

    • my-app-scheme:/
    • my-app-scheme://foo/bar/...
    • my-app://action?param1=value1&param2=value2
• La longueur maximale d'une URL de redirection est de 256 caractères.
• Vous pouvez ajouter jusqu'à 10 URL de redirection. Avec plusieurs URL de redirection, vous pouvez avoir des environnements de test et permettre aux utilisateurs de migrer entre deux sites sans temps d'arrêt.

Soumettez pour révision

Pour minimiser les chances que des applications malveillantes nuisent à la communauté, l'enregistrement d'une application ne la rend pas largement accessible. Au lieu de cela, elle reste en mode privé avec une limite de 10 utilisateurs uniques. Ce mode est utile pour les tests et le débogage au sein de votre équipe.

Si vous souhaitez étendre la base d'utilisateurs de votre application, vous devez la publier en mode public en la soumettant pour révision :

1. Allez à la page applications OAuth 2.0.
2. Cliquez sur le bouton Modifier et publier pour l'application que vous souhaitez publier.
3. Remplissez toutes les informations requises, y compris la vidéo de démonstration et la description, puis cliquez sur le bouton Réviser et publier. Un message avec des limites sur les permissions de votre application pendant la période de révision en attente apparaît.
4. Cliquez sur Soumettre pour révision.

Les informations suivantes sont requises pour votre soumission :

• Un lien public vers une Vidéo de démonstration qui ne dure pas plus d'une minute et répond aux exigences suivantes :

  • Commence avec l'utilisateur déconnecté et montre l'action exacte de l'utilisateur, comme cliquer sur Se connecter avec Roblox, qui déclenche la boîte de dialogue de consentement OAuth. La vidéo doit montrer l'ensemble du flux d'autorisation jusqu'à la redirection vers votre application, y compris le contenu de votre application d'origine après la redirection.
  • Montre les mêmes détails d'enregistrement que vous fournissez avec votre soumission.
• Une justification expliquant pourquoi votre application appartient à la catégorie sélectionnée et comment elle utilise les scopes d'autorisation demandés.

Tant que la révision de votre application est en attente, vous ne pouvez pas modifier ou soumettre une autre demande tant que la demande de révision actuelle n'est pas approuvée ou rejetée. Votre application reste en mode privé pendant la révision. Lorsque votre application est approuvée, elle passe en mode public, et vous ne pouvez pas la ramener en mode privé.

Que votre application soit approuvée ou rejetée, vous recevrez une notification par e-mail du résultat lorsque la révision sera terminée.

Modifiez et supprimez votre application

Vous pouvez modifier ou supprimer votre application avec les étapes suivantes si elle n'est pas en cours de révision :

1. Allez à la page applications OAuth 2.0.

2. Cliquez sur Modifier ou Supprimer pour l'application souhaitée.

   • Si vous avez choisi de modifier une application, suivez les mêmes étapes et exigences de l'enregistrement.
   • Si vous avez choisi de supprimer une application, cliquez sur Oui, supprimer pour confirmer la suppression. Après avoir supprimé une application, vous ne pouvez pas la récupérer.

Modifier les informations générales de votre application ou les URL de redirection ne nécessite pas que les utilisateurs réautorisent l'application. Cependant, si vous ajoutez ou modifiez des scopes d'autorisation, vous devez obtenir l'autorisation pour les nouvelles permissions de vos utilisateurs et acquérir un nouvel ensemble de jetons. Si vous n'obtenez pas l'autorisation pour les nouveaux scopes, votre application peut continuer à utiliser les jetons existants, mais est limitée aux scopes précédents.

Pour les applications en mode privé, le système met automatiquement à jour vos modifications avec vos utilisateurs. Pour les applications en mode public, vous devez soumettre l'application pour révision à nouveau pour refléter ces changements. Sinon, le système enregistre les modifications non publiées pour vous sans les publier à la communauté.