Gestión de API Keys
La página API Keys te permite crear, ver y administrar las claves que tus aplicaciones usan para llamar a la API de FourA.
Cómo ver tus claves
La página muestra cada clave a la que tienes acceso: tus claves personales y cada clave que pertenece a una organización a la que perteneces. La membresía es lo que otorga el acceso, por lo que un miembro común también ve las claves de la organización.
| Columna | Qué muestra |
|---|---|
| Name | Nombre para mostrar y, si configuraste una, la descripción |
| Owner | Personal, o el nombre de la organización |
| Key Prefix | Prefijo enmascarado (pk_live_••••••••) con un botón Reveal, o un icono de candado en una clave heredada |
| Status | Active o Inactive |
| Created | Cuándo se creó la clave |
| Last Used | Cuándo realizó una solicitud la clave por última vez |
Busca por nombre o descripción, filtra por Active o Inactive, y ordena por cualquier encabezado. La dirección de ordenamiento alterna entre descendente, ascendente y desactivado.
El filtro Owner
Si perteneces al menos a una organización, aparece un menú desplegable Owner junto al cuadro de búsqueda: Everything, Personal, o una entrada por organización. Reduce la lista a las claves con ese propietario, y el mismo control en Overview, Metrics, Activity y Proxy sigue tu elección, de modo que las cinco páginas siempre coincidan sobre de quién es el tráfico que estás viendo.
Cómo crear una clave
Haz clic en Create Key arriba de la lista (Create API key en la página vacía antes de tu primera clave) y completa:
| Campo | Requerido | Descripción |
|---|---|---|
| Name | Sí | Una etiqueta descriptiva, por ejemplo "production-scraper" o "staging-test" |
| Description | No | Notas sobre para qué se usa esta clave |
| Owner | Sí, si estás en una organización | Personal, o cualquier organización a la que pertenezcas. El selector solo aparece cuando tienes al menos una. |
Cualquier miembro de una organización puede crear una clave que le pertenezca, sin importar su rol. Ese es el objetivo de la configuración: el uso de una clave de organización se factura al propietario de la organización, de modo que un desarrollador no necesita una clave personal que le facture en silencio a él en lugar de a la empresa.
La clave completa se muestra una sola vez justo después de la creación en un cuadro de diálogo listo para copiar. Puedes volver a verla más tarde con Reveal. Las claves usan el prefijo pk_live_ y se ven como pk_live_a1b2c3d4e5f6.... Recibirás un correo electrónico confirmando que la clave fue creada.
Cómo revelar una clave
Haz clic en el icono del ojo junto al prefijo enmascarado de una clave para ver su secreto completo nuevamente. El panel te pide confirmar y luego abre un cuadro de diálogo con la clave en texto plano, un botón de copia y una cuenta regresiva corta. Después de la cuenta regresiva, el cuadro de diálogo borra el secreto de la página.
Cada revelación se registra en el log de auditoría, ya que expone una credencial activa.
Cualquier persona con la que se comparta la clave puede revelarla: su propietario personal o cualquier miembro de la organización a la que pertenece.
Claves heredadas
Las claves creadas antes del lanzamiento de la función para mostrar muestran un icono de candado en lugar del ojo y no se pueden mostrar. Solo se guardó su hash, por lo que el secreto original no se puede recuperar. Para migrar una clave antigua, abre el menú de acciones y elige Regenerar. El nuevo secreto se podrá mostrar a partir de ese momento.
Qué puede hacer cada rol
En una clave personal puedes hacer todo. En una clave de organización, se aplican tres niveles:
| Acción | Miembro | Administrador | Propietario |
|---|---|---|---|
| Usar la clave y mostrarla | Sí | Sí | Sí |
| Renombrarla, editar la descripción | Sí | Sí | Sí |
| Habilitarla o deshabilitarla | No | Sí | Sí |
| Regenerar el secreto | No | Sí | Sí |
| Eliminarla | No | Sí | Sí |
| Moverla fuera de la organización | No | No | Sí |
Deshabilitar y Editar permanecen en la fila, pero aparecen en gris con una nota que explica el motivo. Regenerar, Transferir y Eliminar no aparecen en el menú cuando tu rol no puede usarlos. La API rechaza las mismas acciones, por lo que una integración no puede eludir la interfaz.
La división se basa en el impacto que cada acción tiene sobre las personas que comparten la clave. Renombrar es inocuo. Regenerar o deshabilitar detiene la integración de cada compañero en el instante en que ocurre. Mover una clave fuera la retira de la empresa y asigna su uso al plan propio de quien la toma, por lo que esa acción corresponde únicamente al propietario.
Editar una clave
Haz clic en Editar para actualizar el nombre y la descripción. La propiedad no se cambia en este cuadro de diálogo: usa Transferir.
Ver métricas en el menú de acciones abre la Vista general filtrada para esa clave.
Activar y desactivar
Usa Deshabilitar o Habilitar en la fila. Desactivar una clave bloquea cada request a la API que la utilice, y puedes reactivarla en cualquier momento. El cambio surte efecto en cuestión de segundos.
Regenerar una clave
Si sospechas que una clave ha sido expuesta, abre el menú de acciones y elige Regenerar. Esto crea un nuevo secreto para el mismo ID de clave. El secreto anterior deja de funcionar de inmediato. El nombre, el propietario y todas las demás configuraciones permanecen iguales.
El nuevo secreto se puede seguir mostrando después de cerrar el cuadro de diálogo, por lo que no tienes que copiarlo perfectamente en el primer intento.
Transferir una clave
Transferir en el menú de acciones mueve una clave entre la propiedad personal y la de una organización sin regenerar el secreto. Se conservan el ID de clave, sus métricas y su historial de actividad. Solo cambia el propietario y, con ello, a quién se factura el uso.
| Movimiento | Quién puede hacerlo |
|---|---|
| Clave personal a una organización | Cualquier persona que pertenezca a esa organización |
| Clave de organización hacia afuera, a ti mismo | El propietario de la organización |
| Entre dos organizaciones | El propietario de la organización de la que sale la clave |
Una clave que se mueve a una organización se une a su equipo predeterminado "Todos", que es lo que la hace visible para los miembros. Una clave que se mueve hacia afuera abandona todos los equipos en los que estaba.
Eliminar una clave
Abre el menú de acciones y selecciona Delete. Eliminar una clave que has usado antes la deshabilita: la clave deja de autenticar y permanece en la lista como Inactive, de modo que su historial de Activity y Metrics conserva su nombre. Las claves que nunca se han utilizado se eliminan por completo.
Recibirás un correo electrónico cuando se elimine una clave.
Organization Keys and Billing
El uso de una clave propiedad de una organización se descuenta del plan del propietario de la organización, sin importar quién haya realizado la request. La página Usage & Limits del propietario contabiliza esas claves junto con las personales y las desglosa por separado.
Related
- Authentication: Cómo funcionan las API keys con la API
- Organizations: Roles, miembros y acceso compartido
- Usage & Limits: Qué claves se descuentan de tu plan
- Dashboard Overview: Todas las secciones del dashboard