Acceso API del Proyecto

La pestaña API muestra las credenciales de API de tu proyecto para acceso programático y proporciona visibilidad sobre el uso de la API a través de estadísticas de rate limit, gráficos de uso e historial de solicitudes recientes. Usa estas credenciales para integrar GitScrum con herramientas externas, scripts de automatización y aplicaciones personalizadas.

Descripción General

La interfaz muestra información de uso de API en tiempo real organizada en tres secciones principales: estadísticas de rate limit en la parte superior, un gráfico de uso mostrando solicitudes de los últimos 7 días, y una tabla de solicitudes recientes hechas a tu proyecto.

Sección de Rate Limits

La sección de rate limits muestra tres tarjetas de estadísticas mostrando el estado actual de uso de la API:

Total de Solicitudes

Muestra el número total de solicitudes de API permitidas durante el período de facturación actual. Si tu plan incluye solicitudes ilimitadas, muestra "Ilimitado" en lugar de un número.

Disponible

Muestra cuántas solicitudes quedan disponibles para el período actual. Un número verde indica disponibilidad saludable. Cuando tu plan es ilimitado, también muestra "Ilimitado".

Período

Muestra el rango de fechas del período de facturación actual en formato "inicio → fin" (ej: "1 Dic → 31 Dic"). Esto te ayuda a entender cuándo se reinicia tu contador de solicitudes.

Gráfico de Uso

Un gráfico de barras muestra el volumen de solicitudes de API en los últimos 7 días. Cada barra representa un día, con la altura indicando el número de solicitudes hechas ese día. El gráfico usa un esquema de colores azul con:

• Eje X mostrando fechas en formato corto
• Eje Y mostrando conteo de solicitudes
• Efectos hover destacando barras individuales
• Estado vacío mostrando barras planas cuando no se han hecho solicitudes

Esta visualización ayuda a identificar patrones de uso y detectar picos inusuales en la actividad de la API.

Tabla de Solicitudes Recientes

Cuando se han hecho solicitudes de API a tu proyecto, una tabla muestra la actividad más reciente con las siguientes columnas:

Método

Muestra el método HTTP usado para cada solicitud con insignias de colores:

• GET - Insignia verde para operaciones de lectura
• POST - Insignia azul para operaciones de creación
• PUT - Insignia naranja para operaciones de actualización
• DELETE - Insignia roja para operaciones de eliminación

Endpoint

Muestra la ruta del endpoint de API que fue llamado. Los endpoints largos se truncan con puntos suspensivos.

Tiempo

Muestra cuándo se hizo la solicitud usando tiempo relativo legible (ej: "hace 2m", "hace 1h", "Ayer"). Pasa el mouse sobre el tiempo para ver la marca de tiempo exacta.

Credenciales de API

Haz clic en el botón Obtener Credenciales en el encabezado para abrir el modal de credenciales. Este modal proporciona las claves de autenticación necesarias para acceder a tu proyecto vía API.

API ID

Un identificador único para acceso a la API. Este valor es de solo lectura y no puede ser cambiado. Haz clic en el icono de copia para copiarlo a tu portapapeles. Una confirmación "Copiado" aparece brevemente después de copiar.

Project Key

La clave específica del proyecto usada para autenticación. Esta también es de solo lectura. Haz clic en el icono de copia para copiarlo a tu portapapeles.

Regenerando Credenciales

Si tus credenciales están comprometidas o necesitas rotarlas por seguridad:

1. Haz clic en el botón Regenerar en la parte inferior del modal
2. El sistema genera nuevos valores de API ID y Project Key
3. Actualiza inmediatamente cualquier aplicación usando las credenciales antiguas
4. Las credenciales antiguas dejan de funcionar tan pronto como se generan las nuevas

Advertencia: Regenerar credenciales invalida todas las integraciones existentes usando los valores antiguos. Planifica tu rotación de credenciales cuidadosamente.

Documentación de la API

Haz clic en el enlace Ver documentación en la parte inferior del modal de credenciales para abrir la documentación completa de la API en gitscrum.com. La documentación proporciona:

• Referencia completa de endpoints
• Detalles de autenticación
• Ejemplos de solicitud y respuesta
• Explicaciones de códigos de error

Entendiendo Rate Limits

Los rate limits protegen la API del abuso y aseguran uso justo entre todos los usuarios. Tu plan determina tus límites:

• Los límites se calculan por período de facturación
• El contador Disponible disminuye conforme haces solicitudes
• El contador se reinicia al inicio de cada nuevo período
• Los planes ilimitados muestran "Ilimitado" para total y disponible

Monitoreando la Salud de la API

Usa la pestaña API regularmente para:

1. Verificar cuota restante - Asegurar que tienes suficientes solicitudes disponibles
2. Revisar patrones de uso - El gráfico revela tendencias de uso diario
3. Auditar actividad reciente - La tabla de solicitudes muestra qué endpoints están siendo llamados
4. Detectar anomalías - Picos inusuales pueden indicar problemas de integración o acceso no autorizado

Permisos

El acceso a credenciales y estadísticas de API requiere permisos de Admin o Manager del proyecto. Los miembros del equipo con permisos menores no pueden ver esta pestaña.

Funcionalidades Relacionadas

• Webhooks - Recibe notificaciones en tiempo real cuando ocurren eventos
• Integraciones - Conecta con Slack, Discord, GitHub y otros servicios