Referencia de la API de plataforma
La API REST de vitalera expone 148 endpoints en más de 20 grupos de recursos, cubriendo desde la ingesta de signos vitales hasta la gestión del ciclo de vida de planes de cuidado. Todos los endpoints devuelven JSON y siguen convenciones RESTful con modelos de datos alineados con FHIR R5.
Documentación completa de la API
La referencia interactiva de la API con esquemas de petición/respuesta, detalles de parámetros y payloads de ejemplo está disponible para clientes en el panel de vitalera. Contacte con info@vitalera.io para obtener acceso.
Autenticación y usuarios
| Grupo | Endpoints | Descripción |
|---|---|---|
| Autenticación JWT | 4 | Generar, refrescar, validar y desactivar tokens JWT |
| Autenticación de integración | 1 | Redirección SSO para proveedores de identidad externos |
| Gestión de credenciales | 1 | Rotar credenciales de cliente de aplicación |
| Usuarios y permisos | 1 | Permisos del usuario actual e información de rol |
Participantes
| Grupo | Endpoints | Descripción |
|---|---|---|
| Monitorizados (Pacientes) | 10 | Crear, listar, actualizar, eliminar participantes. Exportar listas, obtener resúmenes, gestionar asignaciones de cuidado y consultar planes por defecto. |
| Profesionales | 5 | Crear, listar, actualizar, eliminar profesionales sanitarios y miembros de equipos de cuidado. |
| Equipos de monitorización | 1 | Listar miembros del equipo de monitorización por definición de plan. |
| Resúmenes | 1 | Contadores agregados de participantes monitorizados. |
Planes de cuidado y tareas
| Grupo | Endpoints | Descripción |
|---|---|---|
| Definiciones de plan | 11 | Gestionar plantillas de plan — listar, obtener, publicar, retirar, revisar. Consultar acciones, configuración de app, organizaciones, campos de perfil y estado de validación. |
| Planes de monitorizado | 26 | Gestión completa del ciclo de vida — crear, activar, suspender, reanudar, completar, revocar. Gestionar miembros del equipo de monitorización, overrides, triggers, desviaciones, campos personalizados y generar informes PDF. |
| Tareas | 10 | Gestionar tareas clínicas y de bienestar — listar, aceptar, iniciar, completar, cancelar, fallar, rechazar. Contadores de tareas pendientes para badges del dashboard. |
Observaciones — Signos vitales
| Grupo | Endpoints | Descripción |
|---|---|---|
| Presión arterial | 2 | Presión sistólica, diastólica y arterial media |
| Frecuencia cardíaca | 2 | Mediciones de frecuencia cardíaca continua y puntual |
| Saturación de oxígeno (SpO2) | 2 | Lecturas de pulsioximetría |
| Temperatura | 2 | Mediciones de temperatura corporal |
| Colesterol | 2 | Paneles de colesterol total, LDL, HDL |
Observaciones — Actividad y fitness
| Grupo | Endpoints | Descripción |
|---|---|---|
| Recuento de pasos | 2 | Datos de pasos diarios e intradía |
| Calorías | 2 | Gasto calórico activo y total |
| Distancia | 2 | Distancia recorrida (caminando, corriendo, ciclismo) |
| Pisos subidos | 2 | Ganancia de elevación y pisos |
| Minutos activos | 2 | Minutos activos diarios por zona de intensidad |
| Entrenamientos | 2 | Sesiones de entrenamiento estructuradas con vueltas, zonas de FC, ritmo |
| VO2 Max | 2 | Consumo máximo de oxígeno estimado |
Observaciones — Sueño y recuperación
| Grupo | Endpoints | Descripción |
|---|---|---|
| Sesiones de sueño | 3 | Duración del sueño, eficiencia y metadatos de sesión |
| Fases del sueño | 2 | Desglose de fases ligero, profundo, REM y despierto |
| Respiración durante el sueño | 2 | Tasa respiratoria y alteraciones durante el sueño |
| Puntuación de estrés | 2 | Niveles y tendencias de estrés diario |
| Puntuación de recuperación | 2 | Disposición de recuperación post-ejercicio |
| Puntuación de esfuerzo | 2 | Esfuerzo cardiovascular por actividad |
| Nivel de energía | 2 | Niveles de Body Battery / reserva de energía |
Observaciones — Especializadas
| Grupo | Endpoints | Descripción |
|---|---|---|
| Glucosa en sangre | 2 | Lecturas puntuales de glucosa en sangre |
| Lecturas CGM | 2 | Puntos de datos de monitorización continua de glucosa |
| Resúmenes CGM | 2 | Tiempo en rango, glucosa media, variabilidad |
| Alertas CGM | 2 | Eventos de alerta de glucosa alta/baja |
| HRV | 2 | Variabilidad de frecuencia cardíaca (RMSSD, SDNN) |
| ECG | 2 | Datos de forma de onda de electrocardiograma |
| Composición corporal | 2 | Peso, % grasa corporal, masa muscular, IMC |
| Temperatura de la piel | 2 | Lecturas continuas de temperatura de la piel |
| Flujo espiratorio máximo | 2 | Monitorización de asma y EPOC |
| Frecuencia respiratoria | 2 | Mediciones de tasa respiratoria |
| Espirometría | 2 | FEV1, FVC y otras métricas de función pulmonar |
| Salud mental | 4 | Seguimiento de estado de ánimo y puntuaciones de evaluación |
Observaciones — General
| Grupo | Endpoints | Descripción |
|---|---|---|
| Calidad de datos | 1 | Métricas de calidad para flujos de datos de observación |
| Carga de archivos FIT | 1 | Cargue archivos FIT de Garmin en bruto para procesamiento |
| Garmin Sleep | 1 | Ingesta directa de datos de la API Garmin Sleep |
| Garmin Gaps | 1 | Identifique lagunas en flujos de datos de Garmin |
Cuestionarios
| Grupo | Endpoints | Descripción |
|---|---|---|
| Cuestionarios | 4 | Listar cuestionarios, obtener detalles, obtener ítems con traducciones (Accept-Language) y consultar respuestas. |
Alarmas
| Grupo | Endpoints | Descripción |
|---|---|---|
| Incidencias detectadas | 7 | Clasificar, cancelar o marcar alarmas como ingresadas por error. Actualizar detalles de clasificación. Consultar alarmas disparadas. |
Citas
| Grupo | Endpoints | Descripción |
|---|---|---|
| Citas | 6 | Ciclo de vida completo de programación — reservar, registrar entrada, cumplir, cancelar, no-show, marcar error. |
Integraciones de dispositivos
| Grupo | Endpoints | Descripción |
|---|---|---|
| Fitbit | 4 | Vincular/desvincular cuentas Fitbit, comprobar estado de vinculación, consultar última sincronización. |
| Garmin | 1 | Endpoints de ingesta directa de datos Garmin. |
Contenido
| Grupo | Endpoints | Descripción |
|---|---|---|
| Biblioteca | 1 | Listar recursos de contenido educativo e informativo. |
URL base
https://api.vitalera.io/api/
Autenticación
Todos los endpoints requieren un token JWT Bearer válido. Consulte Autenticación de la API de plataforma.
Patrones comunes
- Paginación — Los endpoints de listado devuelven resultados paginados con los campos
count,nextyprevious. - Filtrado — La mayoría de endpoints de listado soportan parámetros de consulta para filtrar por estado, fecha y campos específicos del recurso.
- Traducciones — Los recursos con contenido traducible soportan la cabecera
Accept-Language. - Transiciones de estado — Los recursos con ciclos de vida (tareas, planes, citas, alarmas) utilizan endpoints dedicados
POST /{id}/{action}/. - Límites de tasa — Consulte Límites de tasa y cuotas.
Obtener acceso completo
La referencia interactiva de la API con esquemas completos de petición/respuesta, documentación de parámetros y un entorno sandbox está disponible para clientes. Contáctenos para obtener credenciales.