Gestionar claves de API

Open Cloud autentica y autoriza el acceso a la API con el uso de claves API, que te permiten agregar permisos y control de seguridad granulares para acceder y utilizar ciertos recursos en tu experiencia, como almacenes de datos y lugares.

Todas las API de Open Cloud requieren que crees una llave de API con permisos válidos y incluyas un encabezado x-api-key en tu solicitud, lo que permite que la aplicación se autentique en Open Cloud en tu nombre.

Creando Claves de API

Puede crear y configurar las API para sus experiencias de propiedad individual o las experiencias de propiedad del grupo (un grupo de Roblox permite que varios creadores trabajen en la misma experiencia, usemos los mismos recursos y compartamos las llaves de API).

Debe ser el propietario del grupo o asignado a un rol dentro del grupo que tenga la autorización de administrador de la llave API para crear una llave API para su grupo. Un miembro del grupo solo puede crear una llave API con las mismas autorizaciones de acceso de recursos de su rol. Por ejemplo, solo los miembros del grupo con el permiso de Crear y editar experiencias de grupo pueden crear una llave API que puede publicar un archivo de lugar.

Para crear una clavede API:

1. Navegar al Panel del Creador .

2. (Opcional) Haz clic en el menú desplegable de Crear Centro de Creator para seleccionar un grupo si estás creando la llave de API para un grupo.

3. En el menú de navegación de la izquierda, seleccione Abrir nube → Claves de API .

4. Haga clic en el botón Crear clave de API .

5. Ingrese un nombre único para su clave API. Usa un nombre que pueda ayudarte a recordar el propósito más tarde, como PLACE_PUBLISHING_KEY para publicar lugares en tu experiencia.

6. En la sección Permisos de acceso , seleccione una API del menú Seleccionar sistema de API y haga clic en el botón Añadir sistema de API . Repita este paso si necesita agregar múltiples API a la clave.

7. Seleccione la experiencia que desea acceder con la clave API.

8. De la lista desplegable Operaciones de Experiencia , seleccione las operaciones que desea habilitar para la clavede API.

   Muchas operaciones en la API reference incluyen los rangos de permiso requeridos. Por ejemplo, la operación flush memory store requiere el permiso universe.memory-store:flush.

   Por razones de seguridad, proporciona a cada clave de API el número mínimo de permisos requeridos. Si una clave de API se filtra, este principio de menor privilegio garantiza que solo se comprometa un subconjunto de tus recursos.

9. En la sección Seguridad, específicamente establece el acceso IP a la clave usando CIDR notation, de lo contrario no puedes usar la llave de API. Puedes encontrar la dirección IP de tu máquina local y

10. (Opcional) : Para agregar protección adicional para sus recursos, configure una fecha de caducidad explícita para que su clave deje de funcionar automáticamente después de esa fecha.

11. Haga clic en el botón Guardar y generar clave .

12. Copia y guarda la API key string en una ubicación segura que no sea no una repositoría pública de tu código.

13. Consulte su clave de API creada en la página Credenciales de Crear un tablero de mando .

Permisos de API de propiedad del grupo

Los propietarios del grupo pueden administrar las API de propiedad del grupo para que los miembros del grupo tengan diferentes niveles de control de las llaves de API según los roles y permisos dentro del grupo. También hay situaciones que revocan automáticamente las autorizaciones de gestión de las llaves de API para los miembros del grupo.

Permisos de otorgación

Como propietario de un grupo, puede otorgar el permiso Administrar todas las llaves de API a los roles dentro de su grupo. Los miembros con este permiso tienen todos los permisos que un propietario de grupo tiene para las llaves de API, incluida la capacidad de crear, vista, editar, revocar y auditar todas las llaves de API del grupo.

También puede otorgar el permiso Gestionar propias llaves de API a los roles dentro de su grupo. Esto permite que los miembros solo creen y vean las llaves propiedad de ellos en lugar de poder administrar las llaves de otros.

Invalidez de permisos

Hay varias situaciones que revocan automáticamente el permiso de un miembrosdel grupo para administrar las llaves de API del grupo:

• El miembro se asigna a un papel diferente que no tiene permiso. Esto puede ocurrir durante una transferencia de la propiedad del grupo.
• La autorización del miembrosestá desactivada en su papel actualmente asignado.
• El miembro se va o es eliminado del grupo.
• La cuenta del miembrosestá sujeta a la moderación de Roblox.

En cualquiera de estos casos, las llaves de API generadas por ese usuario se dan el estado Revocado . Para usar estas llaves de nuevo, el propietario del grupo o un miembro con el permiso Administrar todas las llaves de API debe generar las llaves.

Formato CIDR

Para proteger aún más sus recursos, cuando se crea una llave de API, especifique direcciones IP que pueden acceder a la llave de API con cualquier dirección IP normal o usando la notación CIDR IP. Un ID de dirección IP se ve como una dirección IP normal excepto que termina con un guión y un decimal que representa la cantidad de bits del dirección IP que es significativo para la enrutación de la red:

• Normal : 192.168.0.0
• CIDR : 192.168.0.0/24

La parte anterior es la dirección IP y la parte superior es la net máscara , que cuenta los bits de 1s en formato binario. En el ejemplo anterior, 24 significa 255.255.255.0 (24

Estado de la llave de API

Las llaves de API tienen inicialmente un estado activo, pero pueden volverse inactivas durante su vida útil. Para aprender por qué una llave de API ha cambiado el estado y cómo devolver la llave de API a un estado activo, consulte la siguiente tabla.