API

Reasignando Claves API

Gigantics facilita cambiar qué claves API están asignadas a un endpoint sin interrumpir tus integraciones existentes. Cuando reasignas claves, la URL del endpoint permanece sin cambios, asegurando que cualquier sistema o cliente que ya esté usando el endpoint continúe funcionando perfectamente.

¿Por Qué Reasignar Claves?

Hay varios escenarios comunes donde podrías necesitar reasignar claves API a un endpoint:

  • Rotación de Claves: Reemplazar claves antiguas con nuevas durante actualizaciones de seguridad
  • Gestión de Acceso: Otorgar o revocar acceso para equipos o socios específicos
  • Consolidación de Claves: Consolidar múltiples claves en menos, mejor gestionadas
  • Revocación de Emergencia: Remover rápidamente claves comprometidas mientras mantienes el servicio

Estabilidad de URL de Endpoint

Lo más importante que debes entender sobre reasignar claves API es que la URL del endpoint nunca cambia. Ya sea que asignes una clave o diez, remuevas claves, o intercambies claves completamente, la URL del endpoint permanece consistente.

Asignación inicial:
https://yourserver/api/org/proj/model/1/dataset/42?api_key=clave-antigua-123

Después de reasignar claves diferentes:
https://yourserver/api/org/proj/model/1/dataset/42?api_key=clave-nueva-456

                         Misma ruta URL, clave diferente

Esto significa:

  • ✅ Tus integraciones API continúan funcionando (solo necesitan claves actualizadas)
  • ✅ No necesitas actualizar documentación o configuraciones
  • ✅ El endpoint en sí se preserva y es estable
  • ✅ Cambiar claves no afecta el conjunto de datos o pipeline subyacente

Cómo Funciona la Reasignación

Proceso Paso a Paso

  1. Navega al endpoint: Ve a cualquiera de los dos:

    • Modelo → Conjuntos de Datos y haz clic en el ícono de compartir (📤) en un conjunto de datos
    • Modelo → Pipelines y haz clic en el ícono de compartir (📤) en un pipeline
  2. Abre el modal de asignación: El modal muestra todas las claves API disponibles en tu proyecto

  3. Cambia tu selección:

    • Haz clic en "Asignar" para agregar una clave al endpoint
    • Haz clic en "Asignado" para remover una clave del endpoint
    • Puedes seleccionar múltiples claves a la vez
  4. Confirma: Haz clic en "Confirmar" para guardar tus cambios

Qué Sucede Detrás de Escena

Cuando reasignas claves, Gigantics realiza una actualización suave:

┌─────────────────────────────────────────────────────────────┐
│ Antes de la Reasignación                                     │
├─────────────────────────────────────────────────────────────┤
│ Endpoint: /api/org/proj/model/1/dataset/42                  │
│ Claves Asignadas:                                           │
│   │ production-key-2024                                     │
│   │ backup-key-2024                                         │
└─────────────────────────────────────────────────────────────┘

                    │ Cambias a:

┌─────────────────────────────────────────────────────────────┐
│ Después de la Reasignación                                  │
├─────────────────────────────────────────────────────────────┤
│ Endpoint: /api/org/proj/model/1/dataset/42                  │
│ Claves Asignadas:                                           │
│   │ production-key-2025                                     │
│   │ partner-key-acme                                        │
└─────────────────────────────────────────────────────────────┘

                    │ URL del endpoint permanece igual │
                    │ Claves antiguas dejan de funcionar       │
                    │ Claves nuevas empiezan a funcionar       │

Actualizaciones Inmediatas de UI

Cuando reasignas claves, la interfaz se actualiza inmediatamente sin requerir actualización de página:

Actualizaciones de Página de Claves API

En la página Proyecto → Claves API, cada clave muestra a qué endpoints puede acceder. Cuando reasignas claves:

  • ✅ Las claves que ganan acceso inmediatamente muestran el nuevo endpoint en su lista
  • ✅ Las claves que pierden acceso inmediatamente ven el endpoint removido de su lista
  • ✅ Los cambios se reflejan instantáneamente en todas las vistas

Páginas de Conjuntos de Datos y Pipelines

En las páginas de conjuntos de datos y pipelines:

  • ✅ La información del endpoint se actualiza para mostrar asignaciones de claves actuales
  • ✅ No se crean endpoints duplicados
  • ✅ La URL del endpoint mostrada permanece consistente

Ejemplo de Rotación de Claves

Aquí hay un ejemplo práctico de rotar claves sin interrupción del servicio:

Día 1: Configuración Inicial

Tienes una clave de producción asignada a tu endpoint de conjunto de datos:

  • Endpoint: /api/org/proj/model/1/dataset/42
  • Clave Asignada: prod-key-2024

Día 2: Agregar Nueva Clave

Creas una nueva clave y asignas tanto la antigua como la nueva:

  • Endpoint: /api/org/proj/model/1/dataset/42 (misma URL)
  • Claves Asignadas:
    • prod-key-2024 (antigua)
    • prod-key-2025 (nueva)

Ambas claves funcionan durante este período de transición.

Día 3: Actualizar Clientes

Actualizas todos tus clientes para usar la nueva clave. La clave antigua sigue funcionando como respaldo.

Día 4: Remover Clave Antigua

Una vez que todos los clientes han migrado, reasignas para remover la clave antigua:

  • Endpoint: /api/org/proj/model/1/dataset/42 (misma URL)
  • Claves Asignadas:
    • prod-key-2025 (nueva)

La clave antigua deja de funcionar, pero la URL del endpoint nunca cambió, así que tus integraciones permanecen intactas.

Mejores Prácticas

Rotación de Claves Elegante

  1. Crea la nueva clave primero antes de remover la antigua
  2. Asigna ambas claves al endpoint durante la transición
  3. Actualiza clientes gradualmente mientras ambas claves están activas
  4. Monitorea el uso para asegurar que todos los clientes han migrado
  5. Remueve la clave antigua solo después de que la migración esté completa

Gestión de Acceso

  • Asigna propósitos descriptivos a las claves (ej., "Socio A - Q1 2025") para rastrear reasignaciones
  • Revisa asignaciones regularmente para asegurar que las claves aún se necesitan
  • Documenta cambios de claves en tus sistemas de seguimiento internos
  • Usa múltiples claves para diferentes propósitos en lugar de compartir una sola clave

Escenarios de Emergencia

Si una clave está comprometida:

  1. Reasigna inmediatamente para remover la clave comprometida
  2. Mantén otras claves activas para mantener el servicio
  3. Crea una clave de reemplazo y asígnala
  4. Notifica a las partes afectadas para actualizar sus integraciones

La URL del endpoint permanece sin cambios, así que los clientes solo necesitan actualizar su clave API, no su código de integración.

Solución de Problemas

"Mi endpoint desapareció después de reasignar"

La URL del endpoint es estable, pero si has removido todas las claves de un endpoint, necesitarás asignar al menos una clave de nuevo. El endpoint en sí no se elimina - solo necesita una asignación de clave activa.

"Las claves antiguas siguen funcionando después de reasignar"

Después de reasignar claves, las claves antiguas dejan de funcionar inmediatamente. Si las claves antiguas siguen funcionando, verifica:

  • ¿Realmente hiciste clic en "Confirmar" en el modal?
  • ¿Estás probando con la URL correcta del endpoint?
  • ¿Hay un problema de caché en tu aplicación cliente?

"La lista de endpoints no se está actualizando"

La UI se actualiza inmediatamente después de la reasignación. Si no ves cambios:

  • Actualiza la página (aunque no debería ser necesario)
  • Verifica que tienes los permisos correctos (ManageAPIKeys)
  • Confirma que estás viendo el proyecto correcto

Documentación Relacionada