API

Gestionando Claves API

La página de gestión de Claves API proporciona una vista centralizada de todas tus claves API, sus endpoints asignados y estadísticas de uso. Esto facilita entender qué claves tienen acceso a qué recursos y rastrear cómo se está usando tu API.

Accediendo a la Página de Claves API

Para ver y gestionar claves API:

  1. Navega a Proyecto → Claves API
  2. Debes tener el permiso ManageAPIKeys para acceder a esta página

Solo los usuarios con los permisos apropiados pueden ver y gestionar claves API. Si no tienes acceso, contacta a tu administrador de proyecto.

Viendo Tus Claves API

La página de Claves API muestra todas las claves API en tu proyecto en formato de tabla con la siguiente información:

Columnas de Información de Clave

ColumnaDescripción
PropósitoEl nombre descriptivo que le diste a la clave al crearla (ej., "Acceso de Producción", "Integración de Socio")
Clave APIEl prefijo de la clave seguido de *** por seguridad (ej., abc123xyz-***)
Última llamadaCuándo se usó la clave por última vez, mostrado como tiempo relativo (ej., "hace 2 horas", "ayer")
┌─────────────────────────────────────────────────────────────┐
│ Proyecto │ Claves API                                        │
├─────────────────────────────────────────────────────────────┤
│ [Buscar Claves API...]                    [Crear]            │
├─────────────────────────────────────────────────────────────┤
│ Propósito        │ Clave API        │ Última llamada         │
├─────────────────────────────────────────────────────────────┤
│ Producción       │ abc123xyz-***    │ hace 2 horas           │
│ Acceso Respaldo  │ def456uvw-***    │ hace 3 días            │
│ Socio Acme       │ ghi789rst-***    │ ayer                   │
└─────────────────────────────────────────────────────────────┘

Buscando Claves API

Usa la caja de búsqueda en la parte superior de la página para filtrar claves por:

  • Propósito: Busca claves por su nombre descriptivo
  • Prefijo de clave: Busca por la porción visible de la clave

Esto facilita encontrar claves específicas en proyectos con muchas claves API.

Viendo Asignaciones de Endpoints

Cada clave API puede expandirse para ver a qué endpoints tiene acceso. Esto te da una vista completa de qué puede hacer cada clave.

Expandiendo una Fila de Clave

  1. Haz clic en el ícono de expandir (▶) en el lado izquierdo de cualquier fila de clave API
  2. La fila se expande para mostrar todos los endpoints asignados a esa clave
  3. Haz clic de nuevo para colapsar la vista
┌─────────────────────────────────────────────────────────────┐
│ Propósito        │ Clave API        │ Última llamada         │
├─────────────────────────────────────────────────────────────┤
│ Producción       │ abc123xyz-***    │ hace 2 horas           │
│   • GET  /api/org/proj/model/1/dataset/42  [Copiar]         │
│     # llamadas: 1523                                         │
│   • POST /api/org/proj/model/1/pipeline/5  [Copiar]         │
│     # llamadas: 84                                           │
├─────────────────────────────────────────────────────────────┤
│ Acceso Respaldo  │ def456uvw-***    │ hace 3 días            │
└─────────────────────────────────────────────────────────────┘

Detalles de Endpoint

Cuando expandes una clave, verás información detallada sobre cada endpoint:

Etiqueta de Método HTTP

Cada endpoint muestra su método HTTP:

  • GET - Para endpoints de conjunto de datos (recuperando datos)
  • POST - Para endpoints de pipeline (activando acciones)

El método se muestra en una etiqueta de color para identificación rápida.

URI del Endpoint

La ruta completa de la URL del endpoint se muestra en fuente monoespaciada, facilitando la lectura e identificación:

/api/org/proj/model/1/dataset/42

Esta es la porción de ruta de la URL completa (excluyendo el dominio de tu servidor).

Copiar URI del Endpoint

Cada endpoint tiene un botón de copiar (📋) que te permite:

  1. Haz clic en el ícono de copiar junto a cualquier URI de endpoint
  2. La ruta completa del endpoint se copia a tu portapapeles
  3. Pégalo en tus clientes API, documentación o código de integración

Esto ahorra tiempo al configurar integraciones API - no necesitas escribir manualmente o construir URLs.

Conteo de Llamadas

Cada endpoint muestra el número de veces que ha sido llamado:

  • Muestra # llamadas: 1523 por ejemplo
  • Te ayuda a entender qué endpoints se usan más activamente
  • Útil para monitorear el uso de API e identificar endpoints populares

Gestionando Endpoints desde la Página de Claves API

Desde la vista expandida de endpoints, puedes:

  • Copiar la URI del endpoint - Haz clic en el ícono de copiar para obtener la ruta del endpoint
  • Eliminar el endpoint - Haz clic en el ícono de eliminar (🗑️) para remover el endpoint
    • Aparecerá un diálogo de confirmación para prevenir eliminación accidental
    • Eliminar un endpoint remueve el acceso para todas las claves asignadas a él

Entendiendo Información de Uso

Marca de Tiempo de Última Llamada

La columna "Última llamada" muestra cuándo se usó cada clave API por última vez:

  • Actividad reciente: "hace 2 horas", "hace 5 minutos"
  • Actividad antigua: "ayer", "hace 3 días", "hace 2 semanas"
  • Nunca usado: Si una clave fue creada pero nunca usada, puede mostrar la fecha de creación

Esto te ayuda a:

  • Identificar claves activas: Claves que se están usando regularmente
  • Encontrar claves no utilizadas: Claves que pueden estar listas para limpieza o eliminación
  • Rastrear rotación de claves: Ver cuándo las nuevas claves empiezan a usarse

Conteos de Llamadas

El conteo de llamadas para cada endpoint te ayuda a entender:

  • Patrones de tráfico: Qué endpoints reciben más solicitudes
  • Uso de claves: Qué tan activamente se está usando cada clave
  • Planificación de recursos: Qué conjuntos de datos o pipelines se acceden más frecuentemente

Trabajando con Múltiples Endpoints

Una sola clave API puede estar asignada a múltiples endpoints. Cuando expandes una clave, verás todos los endpoints a los que puede acceder:

Vista Expandida de Clave:
•  GET  /api/org/proj/model/1/dataset/42    # llamadas: 1523
•  GET  /api/org/proj/model/1/dataset/87    # llamadas: 342
•  POST /api/org/proj/model/1/pipeline/5    # llamadas: 84
•  POST /api/org/proj/model/1/pipeline/12   # llamadas: 23

Esto te da una imagen completa de qué puede hacer cada clave en todo tu proyecto.

Tareas Comunes

Encontrando Qué Claves Acceden a un Endpoint

Para ver qué claves pueden acceder a un endpoint específico:

  1. Abre la página de Claves API
  2. Expande cada clave para ver sus endpoints
  3. Busca la URI del endpoint que te interesa
  4. Todas las claves mostrando ese endpoint tienen acceso a él

Alternativamente, puedes buscar por la ruta del endpoint si la conoces.

Identificando Claves No Utilizadas

Para encontrar claves que no se están usando:

  1. Ordena o escanea la columna "Última llamada"
  2. Busca claves con marcas de tiempo muy antiguas
  3. Expándelas para ver si tienen endpoints asignados
  4. Considera eliminar claves no utilizadas para reducir la superficie de ataque de seguridad

Monitoreando Endpoints Activos

Para ver qué endpoints son más populares:

  1. Expande claves con marcas de tiempo "Última llamada" recientes
  2. Mira los conteos de llamadas para cada endpoint
  3. Los endpoints con conteos altos de llamadas son tus recursos más activos

Mejores Prácticas

Revisión Regular

  • Revisiones semanales o mensuales: Verifica la página de Claves API regularmente para monitorear el uso
  • Limpia claves no utilizadas: Remueve claves que no se han usado en un tiempo
  • Revisa asignaciones de endpoints: Asegúrate de que las claves solo tengan acceso a endpoints que necesitan

Organización

  • Usa propósitos descriptivos: Dale a las claves propósitos claros y descriptivos (ej., "Acceso a Conjunto de Datos de Producción - Q1 2025")
  • Agrupa endpoints relacionados: Asigna endpoints relacionados a la misma clave para gestión más fácil
  • Documenta asignaciones: Mantén registro de qué claves se usan para qué integraciones

Seguridad

  • Monitorea conteos de llamadas: Los picos inusuales en conteos de llamadas pueden indicar acceso no autorizado
  • Revisa acceso de endpoints: Verifica regularmente qué endpoints puede acceder cada clave
  • Remueve acceso innecesario: Revoca acceso de endpoints para claves que ya no lo necesitan

Documentación Relacionada

API Endpoint Assignment

Página anterior

Access Control

Página siguiente

Tabla de Contenidos