🔑 Configurar API Key para probar los endpoints

Introduce tu API Key para probar los endpoints directamente desde esta documentación. La key se envía como header X-API-Key.

📊 Endpoints de Consulta

Endpoints de solo lectura para consultar ubicaciones, espacios, zonas y registros. Requieren API Key con permiso read. Los datos nunca se eliminan — se mantiene historial completo de 5+ años.

GET ?action=get_estructura Árbol jerárquico completo: ubicaciones → espacios → zonas

Devuelve la estructura completa de la red en forma de árbol. Ideal para configuración inicial de integraciones.

ParámetroTipoDescripción
Sin parámetros adicionales
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_estructura"

▶ Probar endpoint

GET ?action=get_ubicaciones Listar ubicaciones (centros deportivos)

Lista todas las ubicaciones de la red con contadores de espacios y zonas.

ParámetroTipoDescripción
activa0 | 1Opcional Filtrar por estado activo/inactivo
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_ubicaciones"

# Solo activas
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_ubicaciones&activa=1"

▶ Probar endpoint

GET ?action=get_espacios Listar espacios (salas, piscinas, pistas...)

Lista todos los espacios de la red. Se puede filtrar por ubicación.

ParámetroTipoDescripción
ubicacion_idstringOpcional ID de la ubicación
activo0 | 1Opcional Filtrar por estado activo
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_espacios&ubicacion_id=UBI_ID"

▶ Probar endpoint

GET ?action=get_zonas Listar zonas (subdivisiones de espacios)

Lista todas las zonas. Se puede filtrar por espacio o ubicación.

ParámetroTipoDescripción
espacio_idstringOpcional ID del espacio
ubicacion_idstringOpcional ID de la ubicación (filtra zonas de todos sus espacios)
activa0 | 1Opcional Filtrar por estado activo
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_zonas&ubicacion_id=UBI_ID"

▶ Probar endpoint

GET ?action=get_registros Consultar registros de ocupación con filtros completos

El endpoint principal para consultar el histórico de ocupación. Soporta filtrado por fechas, ubicación, espacio, zona, hora y tipo. Los resultados incluyen nombres enriquecidos y porcentaje de ocupación. Los registros nunca se borran — historial completo disponible.

ParámetroTipoDescripción
fecha_desdeYYYY-MM-DDOpcional Fecha inicio del rango
fecha_hastaYYYY-MM-DDOpcional Fecha fin del rango
ubicacion_idstringOpcional Filtrar por ubicación
espacio_idstringOpcional Filtrar por espacio
zona_idstringOpcional Filtrar por zona específica
horaHH:00Opcional Filtrar por franja horaria (ej: 10:00)
tipostringOpcional manual | sensor | camara | iot
registrado_porstringOpcional Nombre del usuario o dispositivo
limitintOpcional Máx resultados (default 500, max 5000)
offsetintOpcional Saltar N resultados (paginación)
ordenstringOpcional desc (defecto) | asc — por fecha+hora
# Registros de hoy
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_registros&fecha_desde=2026-03-26&fecha_hasta=2026-03-26"

# Últimos 7 días de una ubicación
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_registros&fecha_desde=2026-03-19&fecha_hasta=2026-03-26&ubicacion_id=UBI_ID"

# Zona específica, franja de las 10h, paginado
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_registros&zona_id=ZONA_ID&hora=10:00&limit=50&offset=0"

▶ Probar endpoint

GET ?action=get_horarios Horarios configurados por ubicación

Devuelve los horarios definidos para las ubicaciones.

ParámetroTipoDescripción
ubicacion_idstringOpcional Filtrar por ubicación
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_horarios"

▶ Probar endpoint

GET ?action=get_resumen Resumen rápido / dashboard de un día

Devuelve un resumen del día con personas por hora y totales globales de la red.

ParámetroTipoDescripción
fechaYYYY-MM-DDOpcional Día a consultar (default: hoy)
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_resumen&fecha=2026-03-26"

▶ Probar endpoint

📈 KPIs y Agregaciones

Endpoint de analítica avanzada con agrupación por múltiples dimensiones.

GET ?action=get_kpis KPIs agregados con agrupación flexible

Calcula métricas agregadas (total personas, medias, máximos, pico) y permite agrupar por fecha, hora, ubicación, espacio, zona, día de la semana o mes.

ParámetroTipoDescripción
fecha_desdeYYYY-MM-DDOpcional Inicio del periodo
fecha_hastaYYYY-MM-DDOpcional Fin del periodo
ubicacion_idstringOpcional Filtrar por ubicación
espacio_idstringOpcional Filtrar por espacio
zona_idstringOpcional Filtrar por zona
agrupar_porstringOpcional fecha | hora | ubicacion | espacio | zona | dia_semana | mes
# KPIs globales del último mes
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_kpis&fecha_desde=2026-02-26&fecha_hasta=2026-03-26"

# Ocupación por día de la semana
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_kpis&agrupar_por=dia_semana"

# Comparativa entre espacios
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_kpis&agrupar_por=espacio&ubicacion_id=UBI_ID"

# Evolución mensual
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=get_kpis&agrupar_por=mes"

▶ Probar endpoint

🔢 Conteo Automático

Endpoints para registrar conteos desde sensores, cámaras y dispositivos IoT. Requieren API Key con permiso count.

POST ?action=count Registrar conteo individual

Registra un conteo de personas en una zona. Si ya existe un registro para la misma zona+fecha+hora, lo actualiza (upsert).

Campo (body JSON)TipoDescripción
zona_idstringREQUERIDO ID de la zona
personasintREQUERIDO Número de personas
fechaYYYY-MM-DDOpcional Default: hoy
horaHH:00Opcional Default: hora actual
device_idstringOpcional Identificador del dispositivo
tipostringOpcional sensor | camara | manual | iot
curl -X POST -H "X-API-Key: TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"zona_id":"ZONA_ID","personas":25,"tipo":"sensor"}' \
  "https://espacios.fitmetrics.es/api.php?action=count"
POST ?action=count_batch Registrar múltiples conteos a la vez

Registra varios conteos en una sola petición. Ideal para dispositivos que acumulan datos offline.

curl -X POST -H "X-API-Key: TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "registros": [
      {"zona_id":"Z1","personas":10,"hora":"09:00"},
      {"zona_id":"Z1","personas":25,"hora":"10:00"},
      {"zona_id":"Z2","personas":8,"hora":"09:00"}
    ]
  }' \
  "https://espacios.fitmetrics.es/api.php?action=count_batch"
GET ?action=count_status Estado actual de ocupación (hoy)

Devuelve la ocupación actual (último registro del día) de cada zona. Requiere permiso read o count.

ParámetroTipoDescripción
ubicacion_idstringOpcional Filtrar por ubicación
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=count_status"

▶ Probar endpoint

🔐 Gestión de API Keys

Endpoints para crear y gestionar claves de API. Estos endpoints se usan desde el panel de administración.

POST ?action=api_keys_create Crear nueva API Key
Campo (body JSON)TipoDescripción
network_idstringREQUERIDO ID de la red
nombrestringREQUERIDO Nombre descriptivo
descripcionstringOpcional
permisosarrayOpcional ["read","write","count"] — default: ["read","count"]
curl -X POST -H "Content-Type: application/json" \
  -d '{"network_id":"enjoy","nombre":"Sensor Entrada","permisos":["read","count"]}' \
  "https://espacios.fitmetrics.es/api.php?action=api_keys_create"
GET ?action=api_keys_list&network=ID Listar API Keys de una red

Devuelve las keys de una red. Las keys se muestran enmascaradas por seguridad.

curl "https://espacios.fitmetrics.es/api.php?action=api_keys_list&network=enjoy"

📡 Dispositivos

Seguimiento del estado de dispositivos conectados (sensores, cámaras).

POST ?action=device_heartbeat Enviar heartbeat de dispositivo

Los dispositivos pueden enviar heartbeats periódicos para monitoreo de estado.

curl -X POST -H "X-API-Key: TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"device_id":"cam-entrada-01","status":"online","metadata":{"temp":42,"uptime":86400}}' \
  "https://espacios.fitmetrics.es/api.php?action=device_heartbeat"
GET ?action=devices_list Listar dispositivos conectados
curl -H "X-API-Key: TU_API_KEY" \
  "https://espacios.fitmetrics.es/api.php?action=devices_list"

▶ Probar endpoint

⚠️ Códigos de Error

CódigoSignificadoDescripción
400Bad RequestFaltan parámetros requeridos o JSON inválido
401UnauthorizedAPI Key no proporcionada o inactiva
403ForbiddenLa API Key no tiene los permisos necesarios
404Not FoundRed, zona o recurso no encontrado

Todas las respuestas de error incluyen un campo "error" con un mensaje descriptivo:

{"error": "API key required with read permission"}

Permisos por endpoint

EndpointPermiso requerido
get_ubicaciones, get_espacios, get_zonas, get_registros, get_kpis, get_estructura, get_horarios, get_resumenread
count, count_batchcount o write
count_statusread o count
api_keys_*Sin autenticación (gestión desde panel admin)