Administrar claves de API

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

Todas las API de nube abiertas requieren que crees una clave API con permisos válidos e incluyas una cabecera x-api-key en tu solicitud, que permite que la aplicación se autentique en Open Cloud en tu nombre.

Crear claves de API

Puedes crear y configurar claves API para tus experiencias individualmente propiedad o experiencias de propiedad grupal (un grupo de Roblox grupo permite que varios creadores trabajen en la misma experiencia, usen los mismos recursos y compartan claves API).

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

Para crear una clave de API:

Navegue hasta el Panel del creador.
(Opcional) Haga clic en el desplegable Centro de creadores para seleccionar un grupo si está creando la clave de API para un grupo.
En el menú de navegación de la izquierda, seleccione Abrir nube → Claves de API .
Haga clic en el botón Crear clave de API .
Ingrese un nombre único para la clave de API.Usa un nombre que pueda ayudarte a recordar el propósito más tarde, como PLACE_PUBLISHING_KEY para publicar lugares a tu experiencia.
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.
Seleccione la experiencia que desea acceder con la clave de API.
Desde el menú desplegable de Operaciones de experiencia , seleccione las operaciones que desea habilitar para la clave de API.

Muchas operaciones en la referencia de la API incluyen los alcances de permiso requeridos.Por ejemplo, la operación limpieza del almacén de memoria requiere el permiso universe.memory-store:flush.

Por razones de seguridad, asigne a cada clave de API el número mínimo de permisos requeridos.Si se filtra una clave de API, este principio de menor privilegio garantiza que solo se vea comprometido un subconjunto de sus recursos.
En la sección Seguridad , establezca explícitamente el acceso IP a la clave usando notación CIDR, de lo contrario no podrá usar la clave de API.Puedes encontrar la dirección IP de tu máquina local y agregarla a la sección Direcciones IP aceptadas junto con direcciones IP adicionales para aquellos que necesitan acceso.Si no tienes una IP fija, o estás usando la clave de API solo en un entorno, ambientelocal, puedes agregar 0.0.0.0/0 a la sección Direcciones IP aceptadas para permitir que cualquier IP use tu clave de API.
(Opcional) : Para agregar una protección adicional para sus recursos, establezca una fecha de vencimiento explícita para que su clave deje de funcionar automáticamente después de esa fecha.
Haga clic en el botón Guardar y generar clave .
Copia y guarde la cadena de claves de la API en una ubicación segura que no sea un repositorio público de tu código .
Compruebe su clave API creada en la página extensiones de API de tablero de creación del creador .

La cadena de clave de la API es equivalente a la contraseña de tu aplicación.Nunca compártalo con partes no confiables, como cualquier persona fuera de su equipo de desarrollo.

Permisos de clave de API de propiedad del grupo

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

Permisos de otorgación

Como propietario de grupo, puedes otorgar el permiso Gestionar todas las claves de API a roles dentro de tu grupo.Los miembros con este permiso tienen todas las permisos que un propietario de grupo tiene para las claves de API, incluida la capacidad de crear, vista, editar, revocar y auditar todas las claves de API del grupo.

También puedes conceder el permiso Gestionar las propias claves de API a roles dentro de tu grupo.Esto permite que los miembros solo creen y vean las claves que poseen en lugar de poder administrar las claves de otros.

Validación de permisos

Hay múltiples situaciones que revocan automáticamente el permiso de un miembrosdel grupo para administrar las claves de API del grupo:

Al miembro se le asigna un rol diferente que no tiene permiso. Esto puede ocurrir durante una transferencia de la propiedad del grupo.
El permiso del miembrosestá deshabilitado en su rol actualmente asignado.
El miembro se va o se elimina del grupo.
La cuenta del miembrosestá bajo moderación por parte de Roblox.

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

Formato CIDR

Para proteger aún más sus recursos, al crear una clave de API, especifique direcciones IP que puedan acceder a la clave de API con direcciones IP normales o usando la notación CIDR.Una dirección IP CIDR se parece a una dirección IP normal excepto que termina con un guión y un decimal que representa cuántos bits de la dirección IP son significativos para la ruta de red:

Normal : 192.168.0.0
CIDR : 192.168.0.0/24

La parte anterior es la dirección IP y la parte posterior es la máscara de red , que cuenta los bits de 1s en formato binario.En el ejemplo anterior, 24 significa 255.255.255.0 (24 1s) que permite todas las IP entre 192.168.0.0 y 192.168.0.255 .Entender el formato CIDR es particularmente útil si usted planea ejecutar sus aplicaciones en un servidor.

estadode la clave API

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

Si usted o su grupo no usa o actualiza una clave de API durante 60 días, expira automáticamente, incluso si no tiene una fecha de vencimiento establecida.Esto reduce el riesgo de que actores malos usen viejas claves de API.Si ya no estás usando una clave de API, deberás desactivarla o eliminarla manualmente.

Estado	Razón	Resolución
Activo	Sin problemas. El usuario puede usar la clave para autenticar las llamadas API.	N/A
Deshabilitado	El usuario desactivó la clave desactivando la opción Habilitar clave.	Habilita la opción Habilitar la clave alternar/activar.
Caducado	La fecha de expiración de la clave ha pasado.	O elimina o establece una nueva fecha de vencimiento.
Expirado automático	El usuario no ha utilizado o actualizado la clave en los últimos 60 días.	Puede deshabilitar y luego habilitar el alternar/activarHabilitar clave, o puede actualizar cualquiera de las propiedades de la clave, como el nombre, la descripción o la fecha de expiración.
Revocado	Solo para claves de grupo. La cuenta que generó la clave ya no tiene permiso de acceso suficiente para administrar las claves del grupo.	Haga clic en el Regenerar clave para obtener un nuevo secreto.
Moderado	Un administrador de Roblox cambió el secreto de la clave por razones de seguridad.	Haga clic en el Regenerar clave para obtener un nuevo secreto.
Usuario moderado	La cuenta que generó la clave está moderada por Roblox.	Resuelve el problema de moderación en la cuenta.