Enregistrement d'application OAuth 2.0

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

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

Enregistrement de votre application

Pour enregistrer une application :

  1. Dans le tableau de bord du créateur, allez sur la page applications OAuth 2.0.
  2. Cliquez sur le bouton Créer une application OAuth 2.0 .
  3. Entrez un nom d'application unique au monde .
  4. Lisez et acceptez les Conditions d'utilisation de Roblox et cliquez sur Créer .
  5. Copiez et stockez le identifiant du client et le secrets dans un emplacementsûr. Après avoir fermé la page, vous n'avez plus accès au secret et ne pouvez générer qu'un nouveau. Après avoir enregistré 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, qui est décrite dans les sections suivantes.

Configurer les informations générales

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

  • Une description, qui est visible pour tout le monde dans la communauté Roblox.
  • Une image de vignette pour votre application. La taille de fichier recommandée est au moins 150x150 pixels.
  • Un lien d'entrée en tant que point d'entrée de votre application, comme la page d'accueil du site Web de l'application.
  • Une URL de conditions d'utilisation de confidentialité et une URL de conditions d'utilisation du service pour les utilisateurs finaux à lire avant d'autoriser votre application. Chaque URL doit être HTTPS et ne doit pas dépasser 256 caractères.

Ajouter des permissions

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

  • Les scopes d'identité pour l'authentification, tels que openid pour les ID des utilisateurs et profile pour les profils complets. Si vous sélectionnez le scopé 0> profile 0>, vous devez également sélectionner 3> openid 3>.
  • API-spécifiques scopes d'autorisation , tels que asset:read pour la permission de lecture des ressources. Sélectionnez seulement le nombre minimum de scopes dont vous avez besoin pour votre application.

Ajouter des URL de redirection

Redirigez les URLS sont les points de redistribution de votre application que les utilisateurs sont redirigez quand ils finissent d'autoriser votre application. Assurez-vous que vos redirections URLS répondent aux exigences suivantes :

  • Toutes les URL 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 signé par vous-même) à des fins de débogage local, par exemple :
      • http://localhost:80
      • https://localhost:80
    • Des schémas personnalisés pour des applications ou des buts 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.

Envoyer pour révision

Pour minimiser les chances que les applications malveillantes nuisent à la communauté, la registration d'une application ne la rend pas publiquement accessible. Au lieu de cela, il reste dans le mode privé avec une limite de 100 utilisateurs autorisés. Ce mode est utile pour tester et déboguer dans votre équipe.

Si vous souhaitez étendre la base d'utilisateurs pour votre application, vous devez le publier en mode public en le soumettant pour une examiner:

  1. Allez sur la page OAuth 2.0 Apps.
  2. Cliquez sur le bouton Modifier et publier pour l'application que vous souhaitez publier.
  3. Remplissez toutes les informations requises et cliquez sur le bouton Réviser et publier . Une message avec des limites sur vos permissions d'application pendant la période de review en attente apparaît.
  4. Cliquez sur Envoyer pour la révision .

Pendant que votre demande d'évaluation est en attente, vous ne pouvez pas modifier ou soumettre une autre demande jusqu'à ce que la demande d'évaluation actuelle soit approuvée ou rejetée. Votre app est en mode privé pendant la examiner. Lorsque votre app est approuvé, il passe en mode public et vous ne pouvez pas le rétablir en mode privé.

Que votre application soit approuvée ou rejetée, vous recevez une notification par courrier électronique du résultat lorsque la révision est terminée.

Modifier et supprimer votre application

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

  1. Allez sur la page OAuth 2.0 Apps.

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

    • Si vous choisissez de modifier une application, suivez les mêmes étapes et exigences de l'enregistrement .
    • Si vous choisissez 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.

La modification des informations générales de votre application ou des URL de redirection ne nécessite pas que les utilisateurs reçoivent l'autorisation de la nouvelle autorisation. Cependant, si vous ajoutez ou modifiez les scopes d'autorisation, vous devez obtenir l'autorisation des nouveaux permissions auprès de vos utilisateurs et acquérir un nouveau 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 la révision à nouveau pour refléter ces modifications. Sinon, le système enregistre les modifications non publiées pour vous sans les publier à la communauté.