Open Cloud autorise et autorise l'accès à l'API à l'aide de clés API, ce qui vous permet d'ajouter des autorisations granulaires et de contrôle de sécurité pour l'accès et l'utilisation de certaines ressources dans votre expérience, telles que les magasins de données et les lieux.
Toutes les API du cloud Open requièrent que vous créiez une clé API avec des permissions valides et incliez un en-tête x-api-key dans votre demande, ce qui permet à l'application d'authentifier le cloud Open au nom de votre entreprise.
Créer des clés API
Vous pouvez créer et configurer des clés API pour vos expériences appartenant individuellement ou expériences appartenant à un groupe (un groupe Roblox permet à plusieurs créateurs de travailler sur la même expérience, d'utiliser les mêmes ressources et de partager les clés API).
Vous devez être le propriétaire du groupe ou affecté à un rôle dans le groupe qui a la permission d'administration de la clé API dans le but de créer une clé API pour votre groupe. Un membre du groupe ne peut créer qu'une clé API avec les mêmes ressources d'accès de leur rôle. Par exemple, seuls les membres du groupe avec la permission Créer et modifier des expériences de groupe peuvent créer une clé API qui peut publier un fichier de lieu.
Pour créer une clé API :
Accédez à la tableau de bord du créateur.
(Facultatif) Cliquez sur le menu déroulant Centre de créateur pour sélectionner un groupe si vous créez la clé API pour un groupe.
Dans le menu de navigation à gauche, sélectionnez Ouvrir le cloud → Clés API .
Cliquez sur le bouton Créer clé API .
Entrez un nom unique pour votre clé API. Utilisez un nom qui peut vous aider à vous souvenir du but plus tard, comme PLACE_PUBLISHING_KEY pour publier des lieux dans votre expérience.
Dans la section permissions d'accès , sélectionnez une API dans le menu sélectionner le système d'API et cliquez sur le bouton ajouter un système d'API . Répétez cette étape si vous devez ajouter plusieurs API à la clé.
Sélectionnez l'expérience que vous souhaitez accéder avec la clé API.
Dans le Événements d'opérations menu déroulant, sélectionnez les opérations que vous souhaitez activer pour la clé API.
De nombreuses opérations dans la référence de l'API incluent les scopes d'autorisation requis. Par exemple, l'opération flusher memory store nécessite la permission universe.memory-store:flush.
Pour des raisons de sécurité, donnez à chaque clé API le nombre minimum de permissions requises. Si une clé API se perd, ce principe de moins de privilèges garantit que seul un sous-ensemble de vos ressources est compromise.
Dans la section Sécurité, définissez explicitement l'accès IP à la clé en utilisant la norme CIDR, sinon vous ne pouvez pas utiliser la clé API. Vous pouvez trouver l'adresse IP de vot
(Facultatif) : Pour ajouter une protection supplémentaire pour vos ressources, définissez une date d'expiration explicite afin que votre clé arrête automatiquement de fonctionner après cette date.
Cliquez sur le bouton Enregistrer et générer la clé .
Copiez et enregistrez la clé API à un endroit sûr qui n'est pas pas une référence publique de votre code.
Vérifiez votre clé API créée sur la page Crédits du tableau de bord du créateur .
La chaîne de clé de l'API est équivalente au mot de passe de votre application. Ne le partagez jamais avec des parties non autorisées, telles que n'importe qui en dehors de votre équipe de développement.
Permissions des clés API appartenant au groupe
Les propriétaires de groupes peuvent gérer les permissions d'API appartenant à un groupe pour que les membres du groupe aient différents niveaux de contrôle sur les clés API en fonction des rôles et des permissions dans le groupe. Il y a également des situations qui automatiquement révoquent les permissions de gestion des clés API pour les membres du groupe.
Autorisations
En tant que propriétaire d'un groupe, vous pouvez accorder la permission Gérer toutes les clés API à des rôles dans votre groupe. Les membres avec cette permission ont toutes les permissions qu'un propriétaire de groupe a pour les clés API, y compris la capacité de créer, de voir, d'modifier, de retireret d'auditer toutes les clés API de votre groupe.
Vous pouvez également accorder la permission Gérer les clés de l'API aux rôles dans votre groupe. Cela permet aux membres de ne créer et de ne voir que les clés appartenant à eux plutôt que d'être en mesure de gérer les clés des autres.
Invalider les permissions
Il y a plusieurs situations dans lesquelles le permis d'un membre du groupe est automatiquement révoqué pour gérer les clés de l'API de groupe :
- Le membre est attribué à un autre rôle qui n'a pas la permission. Cela peut se produire lors d'un transfert de la propriété du groupe.
- La permission de l'membreest désactivée sur son rôle actuellement attribué.
- Le membre quitte ou est retiré du groupe.
- Le compte du membre est sous la modération de Roblox.
Dans l'un de ces cas, les clés API générées par cet utilisateur sont données le statut Révoqué statut . Pour utiliser ces clés à nouveau, le propriétaire du groupe ou un membre avec la permission Gérer toutes les clés API doit générer les clés.
Format CIDR
Pour protéger vos ressources davantage, lorsque vous créez une clé API, spécifiez des adresses IP qui peuvent accéder à la clé API avec des adresses IP normales ou en utilisant la notation CIDR. Un adresse IP CIDR ressemble à une adresse IP normale à part qu'elle se termine par un slash et un décimal qui représente le nombre de bits de l'adresse IP :
- Normal : 192.168.0.0
- CIDR : 192.168.0.0/24
La partie précédente est l'adresse IP et la partie suivante est le net mask , comptant les bits de 1s en format binaire. Dans l'exemple précédent, 24 signifie 255.255.255.0</
Statut de la clé API
Les clés de l'API ont initialement un statut actif, mais elles peuvent devenir inactives au cours de leur vie. Pour apprendre pourquoi une clé API a changé de statut et comment retourner la clé API au statut actif, consultez le tableau suivant.
Si vous ou votre groupe n'utilisez pas ou n'avez pas mis à jour une clé API pendant 60 jours, il expire automatiquement, même si elle n'a pas de date d'expiration prédéfinie. Cela réduit le risque que les mauvais acteurs utilisent des clés API anciennes. Si vous n'utilisez plus une clé API, vous devez la désactiver ou la supprimer manuellement.
| Statut | Raison | Résolution |
|---|---|---|
| Actif | Pas de problèmes. L'utilisateur peut utiliser la clé pour authentifier les appels d'API. | N/A |
| Désactivé | L'utilisateur a désactivé la clé en désactivant le activer/désactiverActiver la clé. | Activer le activer/désactiverActiver clé. |
| Expiré | La date d'expiration de la clé a expiré. | Supprimez ou définissez une nouvelle date d'expiration. |
| Expiré automatiquement | L'utilisateur n'a pas utilisé ou mis à jour la clé dans les 60 derniers jours. | Vous pouvez soit désactiver, puis activer le activer/désactiverActiver la clé, ou vous pouvez mettre à jour l'une des propriétés de la clé, telles que le nom, la description ou la date d'expiration. |
| Révoqué | Pour les clés de groupe uniquement. Le compte qui a généré la clé n'a plus la permission d'accès suffisante pour gérer les clés du groupe. | Cliquez sur la clé de regénération pour obtenir une nouvelle clé. |
| Modérateur | Un administrateur Roblox a changé le secret de la clé pour des raisons de sécurité. | Cliquez sur la clé de regénération pour obtenir une nouvelle clé. |
| Modérateur | Le compte qui a généré la clé est soumis à la modération par Roblox. | Résolvez le problème de modération sur le compte. |