API

Control de Acceso

La gestión de API en Gigantics está controlada por permisos basados en roles. Solo los usuarios con los permisos apropiados pueden crear, modificar o eliminar claves API y endpoints.

Permiso Requerido

Todas las operaciones de gestión de API requieren el permiso ManageAPIKeys:

  • Crear claves API
  • Editar claves API (cambiar propósito o estado activo)
  • Eliminar claves API
  • Asignar claves API a endpoints
  • Ver claves API y endpoints
  • Eliminar endpoints

Asignación de Permisos

Los permisos se asignan a nivel de proyecto a través de:

  1. Navega a Proyecto → Configuración → Equipo
  2. Asigna a usuarios o roles el permiso ManageAPIKeys
  3. Los usuarios con este permiso pueden acceder a la página Claves API desde el menú del proyecto

Quién Puede Usar Endpoints

Los endpoints de API en sí son accesibles para cualquiera que tenga una clave API válida, independientemente de sus permisos de UI. Esto significa:

  • Los usuarios sin acceso a UI pueden seguir llamando endpoints de API si se les proporciona una clave
  • Los sistemas externos pueden autenticarse usando claves API sin cuentas de usuario
  • El acceso a API es independiente de los permisos de rol de UI

Visibilidad de Claves API

En la UI

  • Las claves API son visibles en su totalidad solo durante la creación
  • La página de Claves API muestra solo el prefijo (primeros 10 caracteres) seguido de ***
  • Ejemplo de visualización: abc123xyz-***

Accediendo a Claves

  • Las claves no se pueden recuperar después de la creación
  • Si se pierde una clave, debes:
    1. Crear una nueva clave API
    2. Asignarla a los endpoints
    3. Actualizar los clientes para usar la nueva clave
    4. Opcionalmente eliminar la clave antigua

Control de Acceso de Endpoints

Creando Endpoints

Para asignar un endpoint de API a un conjunto de datos o pipeline, necesitas:

  • Permiso ManageAPIKeys

Visibilidad de Endpoints

  • Los endpoints pueden ser vistos por cualquiera con permiso ManageAPIKeys
  • Las URIs de endpoints son visibles para ayudar a configurar clientes
  • Los conteos de llamadas son visibles para monitorear el uso

Eliminando Endpoints

  • Requiere permiso ManageAPIKeys
  • Eliminar un endpoint elimina el acceso a API pero no elimina el recurso subyacente (conjunto de datos o pipeline)

Endpoints de Pipeline

Los endpoints de pipeline también requieren el permiso ManagePipelines además de ManageAPIKeys para algunas operaciones:

  • Crear claves API específicas de pipeline
  • Asignar endpoints a pipelines

Mejores Prácticas de Seguridad

  1. Limita el acceso - Solo otorga ManageAPIKeys a usuarios que necesiten gestionar el acceso a API
  2. Monitorea el uso - Revisa regularmente los conteos de llamadas y las marcas de tiempo de último uso
  3. Rota las claves - Crea un horario de rotación y cúmplelo
  4. Usa propósitos descriptivos - Rastrea para qué es cada clave
  5. Desactiva claves no utilizadas - Si una clave no se ha usado recientemente, considera desactivarla
  6. Revisa endpoints - Revisa periódicamente qué endpoints existen y elimina los no utilizados

Documentación Relacionada