Saltar al contingut principal

Referència de l'API de plataforma

L'API REST de vitalera exposa 148 endpoints en més de 20 grups de recursos, cobrint des de la ingesta de signes vitals fins a la gestió del cicle de vida de plans de cura. Tots els endpoints retornen JSON i segueixen convencions RESTful amb models de dades alineats amb FHIR R5.

Documentació completa de l'API

La referència interactiva de l'API amb esquemes de petició/resposta, detalls de paràmetres i payloads d'exemple està disponible per a clients al panell de vitalera. Contacteu amb info@vitalera.io per obtenir accés.

Autenticació i usuaris

GrupEndpointsDescripció
Autenticació JWT4Generar, refrescar, validar i desactivar tokens JWT
Autenticació d'integració1Redirecció SSO per a proveïdors d'identitat externs
Gestió de credencials1Rotar credencials de client d'aplicació
Usuaris i permisos1Permisos de l'usuari actual i informació de rol

Participants

GrupEndpointsDescripció
Monitoritzats (Pacients)10Crear, llistar, actualitzar, eliminar participants. Exportar llistes, obtenir resums, gestionar assignacions de cura i consultar plans per defecte.
Professionals5Crear, llistar, actualitzar, eliminar professionals sanitaris i membres d'equips de cura.
Equips de monitorització1Llistar membres de l'equip de monitorització per definició de pla.
Resums1Comptadors agregats de participants monitoritzats.

Plans de cura i tasques

GrupEndpointsDescripció
Definicions de pla11Gestionar plantilles de pla — llistar, obtenir, publicar, retirar, revisar. Consultar accions, configuració d'app, organitzacions, camps de perfil i estat de validació.
Plans de monitoritzat26Gestió completa del cicle de vida — crear, activar, suspendre, reprendre, completar, revocar. Gestionar membres de l'equip de monitorització, overrides, triggers, desviacions, camps personalitzats i generar informes PDF.
Tasques10Gestionar tasques clíniques i de benestar — llistar, acceptar, iniciar, completar, cancel·lar, fallar, rebutjar. Comptadors de tasques pendents per a badges del dashboard.

Observacions — Signes vitals

GrupEndpointsDescripció
Pressió arterial2Pressió sistòlica, diastòlica i arterial mitjana
Freqüència cardíaca2Mesures de freqüència cardíaca contínua i puntual
Saturació d'oxigen (SpO2)2Lectures de pulsioximetria
Temperatura2Mesures de temperatura corporal
Colesterol2Panells de colesterol total, LDL, HDL

Observacions — Activitat i fitness

GrupEndpointsDescripció
Recompte de passos2Dades de passos diaris i intradia
Calories2Despesa calòrica activa i total
Distància2Distància recorreguda (caminant, corrent, ciclisme)
Pisos pujats2Guany d'elevació i pisos
Minuts actius2Minuts actius diaris per zona d'intensitat
Entrenaments2Sessions d'entrenament estructurades amb voltes, zones de FC, ritme
VO2 Max2Consum màxim d'oxigen estimat

Observacions — Son i recuperació

GrupEndpointsDescripció
Sessions de son3Durada del son, eficiència i metadades de sessió
Fases del son2Desglossament de fases lleuger, profund, REM i despert
Respiració durant el son2Taxa respiratòria i alteracions durant el son
Puntuació d'estrès2Nivells i tendències d'estrès diari
Puntuació de recuperació2Disposició de recuperació post-exercici
Puntuació d'esforç2Esforç cardiovascular per activitat
Nivell d'energia2Nivells de Body Battery / reserva d'energia

Observacions — Especialitzades

GrupEndpointsDescripció
Glucosa en sang2Lectures puntuals de glucosa en sang
Lectures CGM2Punts de dades de monitorització contínua de glucosa
Resums CGM2Temps en rang, glucosa mitjana, variabilitat
Alertes CGM2Esdeveniments d'alerta de glucosa alta/baixa
HRV2Variabilitat de freqüència cardíaca (RMSSD, SDNN)
ECG2Dades de forma d'ona d'electrocardiograma
Composició corporal2Pes, % greix corporal, massa muscular, IMC
Temperatura de la pell2Lectures contínues de temperatura de la pell
Flux espiratori màxim2Monitorització d'asma i MPOC
Freqüència respiratòria2Mesures de taxa respiratòria
Espirometria2FEV1, FVC i altres mètriques de funció pulmonar
Salut mental4Seguiment d'estat d'ànim i puntuacions d'avaluació

Observacions — General

GrupEndpointsDescripció
Qualitat de dades1Mètriques de qualitat per a fluxos de dades d'observació
Càrrega d'arxius FIT1Carregueu arxius FIT de Garmin en brut per a processament
Garmin Sleep1Ingesta directa de dades de l'API Garmin Sleep
Garmin Gaps1Identifiqueu llacunes en fluxos de dades de Garmin

Qüestionaris

GrupEndpointsDescripció
Qüestionaris4Llistar qüestionaris, obtenir detalls, obtenir ítems amb traduccions (Accept-Language) i consultar respostes.

Alarmes

GrupEndpointsDescripció
Incidències detectades7Classificar, cancel·lar o marcar alarmes com a ingressades per error. Actualitzar detalls de classificació. Consultar alarmes disparades.

Cites

GrupEndpointsDescripció
Cites6Cicle de vida complet de programació — reservar, registrar entrada, complir, cancel·lar, no-show, marcar error.

Integracions de dispositius

GrupEndpointsDescripció
Fitbit4Vincular/desvincular comptes Fitbit, comprovar estat de vinculació, consultar última sincronització.
Garmin1Endpoints d'ingesta directa de dades Garmin.

Contingut

GrupEndpointsDescripció
Biblioteca1Llistar recursos de contingut educatiu i informatiu.

URL base

https://api.vitalera.io/api/

Autenticació

Tots els endpoints requereixen un token JWT Bearer vàlid. Consulteu Autenticació de l'API de plataforma.

Patrons comuns

  • Paginació — Els endpoints de llistat retornen resultats paginats amb els camps count, next i previous.
  • Filtratge — La majoria d'endpoints de llistat suporten paràmetres de consulta per filtrar per estat, data i camps específics del recurs.
  • Traduccions — Els recursos amb contingut traduïble suporten la capçalera Accept-Language.
  • Transicions d'estat — Els recursos amb cicles de vida (tasques, plans, cites, alarmes) utilitzen endpoints dedicats POST /{id}/{action}/.
  • Límits de taxa — Consulteu Límits de taxa i quotes.

Obtenir accés complet

La referència interactiva de l'API amb esquemes complets de petició/resposta, documentació de paràmetres i un entorn sandbox està disponible per a clients. Contacteu-nos per obtenir credencials.