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 :
- Dans le Tableau de bord Creator, allez à la page Applications OAuth 2.0.
- Cliquez sur le bouton Créer une application.
- Entrez un Nom d'application valide et globalement unique.
- Lisez et acceptez les Conditions d'utilisation de Roblox et cliquez sur Créer.
- 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 d'autres propriétés de l'application.
- Cliquez sur Continuer pour 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 en tant que point d'entrée de votre application, par exemple, la page d'accueil du site de l'application.
- Une URL des termes de confidentialité et une URL des conditions de service 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 permissions
Pour garantir un contrôle d'accès et une sécurité appropriés dans votre application, vous devez ajouter des Portées de permission. Il existe deux types de portées de permission disponibles :
- Portées d'identité pour l'authentification, telles que openid pour les identifiants d'utilisateur et profile pour les profils complets. Si vous sélectionnez la portée profile, vous devez également sélectionner openid.
- Portées de permission spécifiques à l'API, telles que asset:read pour la permission de lecture des actifs. Sélectionnez uniquement le nombre minimum de portées dont vous avez besoin pour votre application.
Ajoutez des URLs de redirection
Les URLs de redirection sont les points de réentrée de votre application vers lesquels les utilisateurs sont redirigés lorsqu'ils terminent d'autoriser votre application. Assurez-vous que vos URLs de redirection répondent aux exigences suivantes :
- Toutes les URLs de redirection doivent être dans l'une des formes suivantes :
- Plain HTTPS, par exemple : https://www.example.com.`
- Chemins sur localhost avec HTTP ou HTTPS (certificat auto-signé) à des fins de débogage local, par exemple :
- Schémas personnalisés pour des applications ou des objectifs spécifiques, par exemple :
- my-app-scheme:/
- my-app-scheme://foo/bar/...
- my-app://action?param1=value1¶m2=value2
- La longueur maximale d'une URL de redirection est de 256 caractères.
- Vous pouvez ajouter jusqu'à 10 URLs de redirection. Avec plusieurs URLs 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 :
- Allez à la page applications OAuth 2.0.
- Cliquez sur le bouton Modifier et publier pour l'application que vous souhaitez publier.
- Remplissez toutes les informations requises et 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 s'affiche.
- Cliquez sur Soumettre pour révision.
En attendant que votre révision d'application soit en cours, vous ne pouvez pas modifier ou soumettre une autre demande tant que la demande actuelle de révision 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 revenir en arrière 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.
Modifier et supprimer votre application
Vous pouvez modifier ou supprimer votre application avec les étapes suivantes si elle n'est pas en révision :
Allez à la page applications OAuth 2.0.
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 URLs de redirection ne nécessite pas que les utilisateurs réautorisent l'application. Cependant, si vous ajoutez ou modifiez des portées de permission, vous devez obtenir l'autorisation pour les nouvelles permissions de vos utilisateurs et acquérir un nouvel ensemble de tokens. Si vous n'obtenez pas d'autorisation pour les nouvelles portées, votre application peut continuer à utiliser les tokens existants, mais elle est limitée aux portées précédentes.
Pour les applications en mode privé, le système met automatiquement à jour vos modifications auprès de 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 pour la communauté.