Reference de l'API plateforme
L'API REST vitalera expose 148 endpoints repartis dans plus de 20 groupes de ressources, couvrant tout, de l'ingestion de signes vitaux a la gestion du cycle de vie des plans de soins. Tous les endpoints retournent du JSON et suivent les conventions RESTful avec des modeles de donnees alignes sur FHIR R5.
Documentation API complete
La reference API interactive avec les schemas de requete/reponse, les details des parametres et les exemples de payloads est disponible pour les clients dans le tableau de bord vitalera. Contactez info@vitalera.io pour y acceder.
Authentification et utilisateurs
| Groupe | Endpoints | Description |
|---|---|---|
| Authentification JWT | 4 | Generer, rafraichir, valider et desactiver les jetons JWT |
| Authentification d'integration | 1 | Redirection SSO pour les fournisseurs d'identite externes |
| Gestion des identifiants | 1 | Rotation des identifiants client de l'application |
| Utilisateurs et permissions | 1 | Permissions et informations de role de l'utilisateur courant |
Participants
| Groupe | Endpoints | Description |
|---|---|---|
| Personnes suivies (Patients) | 10 | Creer, lister, mettre a jour, supprimer des participants. Exporter des listes, recuperer des resumes, gerer les attributions de soins et interroger les plans par defaut. |
| Professionnels | 5 | Creer, lister, mettre a jour, supprimer des professionnels de sante et membres d'equipe de soins. |
| Equipes de surveillance | 1 | Lister les membres de l'equipe de surveillance par definition de plan. |
| Resumes | 1 | Compteurs agreges des participants suivis. |
Plans de soins et taches
| Groupe | Endpoints | Description |
|---|---|---|
| Definitions de plans | 11 | Gerer les modeles de plans -- lister, recuperer, publier, retirer, reviser. Interroger les actions, les parametres d'application, les organisations, les champs de profil et le statut de validation. |
| Plans de personnes suivies | 26 | Gestion complete du cycle de vie -- creer, activer, suspendre, reprendre, completer, revoquer. Gerer les membres de l'equipe, les remplacements, les declencheurs, les ecarts, les champs personnalises et generer des rapports PDF. |
| Taches | 10 | Gerer les taches cliniques et de bien-etre -- lister, accepter, demarrer, completer, annuler, echouer, rejeter. Compteurs de taches en attente pour les badges du tableau de bord. |
Observations -- Signes vitaux
| Groupe | Endpoints | Description |
|---|---|---|
| Pression arterielle | 2 | Systolique, diastolique et pression arterielle moyenne |
| Frequence cardiaque | 2 | Mesures de frequence cardiaque continues et ponctuelles |
| Saturation en oxygene (SpO2) | 2 | Lectures d'oxymetrie de pouls |
| Temperature | 2 | Mesures de temperature corporelle |
| Cholesterol | 2 | Panels de cholesterol total, LDL, HDL |
Observations -- Activite et fitness
| Groupe | Endpoints | Description |
|---|---|---|
| Nombre de pas | 2 | Donnees de pas quotidiennes et intra-journalieres |
| Calories | 2 | Depense calorique active et totale |
| Distance | 2 | Distance parcourue (marche, course, velo) |
| Etages montes | 2 | Gain d'altitude et etages |
| Minutes actives | 2 | Minutes actives quotidiennes par zone d'intensite |
| Entrainements | 2 | Sessions d'entrainement structurees avec tours, zones FC, allure |
| VO2 Max | 2 | Consommation maximale d'oxygene estimee |
Observations -- Sommeil et recuperation
| Groupe | Endpoints | Description |
|---|---|---|
| Sessions de sommeil | 3 | Duree du sommeil, efficacite et metadonnees de session |
| Stades de sommeil | 2 | Repartition leger, profond, REM et eveil |
| Respiration du sommeil | 2 | Frequence respiratoire et perturbations pendant le sommeil |
| Score de stress | 2 | Niveaux de stress quotidiens et tendances |
| Score de recuperation | 2 | Pret a la recuperation post-exercice |
| Score d'effort | 2 | Effort cardiovasculaire lie a l'activite |
| Niveau d'energie | 2 | Niveaux Body Battery / reserve d'energie |
Observations -- Specialisees
| Groupe | Endpoints | Description |
|---|---|---|
| Glycemie | 2 | Lectures ponctuelles de glycemie |
| Lectures CGM | 2 | Points de donnees de surveillance continue du glucose |
| Resumes CGM | 2 | Temps dans la cible, glucose moyen, variabilite |
| Alertes CGM | 2 | Evenements d'alerte glucose haut/bas |
| HRV | 2 | Variabilite de la frequence cardiaque (RMSSD, SDNN) |
| ECG | 2 | Donnees de forme d'onde d'electrocardiogramme |
| Composition corporelle | 2 | Poids, % masse grasse, masse musculaire, IMC |
| Temperature cutanee | 2 | Lectures continues de temperature cutanee |
| Debit expiratoire de pointe | 2 | Surveillance de l'asthme et de la BPCO |
| Frequence respiratoire | 2 | Mesures de la frequence respiratoire |
| Spirometrie | 2 | VEMS, CVF et autres metriques de fonction pulmonaire |
| Sante mentale | 4 | Suivi de l'etat d'humeur et scores d'evaluation |
Observations -- Generales
| Groupe | Endpoints | Description |
|---|---|---|
| Qualite des donnees | 1 | Metriques de qualite des flux de donnees d'observation |
| Upload de fichier FIT | 1 | Telecharger des fichiers FIT Garmin bruts pour traitement |
| Sommeil Garmin | 1 | Ingestion directe des donnees de l'API Garmin Sleep |
| Lacunes Garmin | 1 | Identifier les lacunes dans les flux de donnees Garmin |
Questionnaires
| Groupe | Endpoints | Description |
|---|---|---|
| Questionnaires | 4 | Lister les questionnaires, recuperer les details, obtenir les items avec traductions (Accept-Language) et interroger les reponses. |
Alarmes
| Groupe | Endpoints | Description |
|---|---|---|
| Problemes detectes | 7 | Classifier, annuler ou marquer les alarmes comme saisies par erreur. Mettre a jour les details de classification. Interroger les alarmes declenchees. |
Rendez-vous
| Groupe | Endpoints | Description |
|---|---|---|
| Rendez-vous | 6 | Cycle de vie complet de la planification -- reserver, enregistrer, honorer, annuler, absence, marquer comme erreur. |
Integrations de dispositifs
| Groupe | Endpoints | Description |
|---|---|---|
| Fitbit | 4 | Lier/delier les comptes Fitbit, verifier le statut de liaison, interroger la derniere synchronisation. |
| Garmin | 1 | Endpoints d'ingestion directe des donnees Garmin. |
Contenu
| Groupe | Endpoints | Description |
|---|---|---|
| Bibliotheque | 1 | Lister les ressources de contenu educatif et informatif. |
URL de base
https://api.vitalera.io/api/
Authentification
Tous les endpoints necessitent un jeton JWT Bearer valide. Consultez Authentification de l'API plateforme.
Modeles courants
- Pagination -- Les endpoints de liste retournent des resultats pagines avec les champs
count,nextetprevious. - Filtrage -- La plupart des endpoints de liste supportent des parametres de requete pour filtrer par statut, date et champs specifiques a la ressource.
- Traductions -- Les ressources avec du contenu traduisible supportent l'en-tete
Accept-Language. - Transitions d'etat -- Les ressources avec des cycles de vie (taches, plans, rendez-vous, alarmes) utilisent des endpoints
POST /{id}/{action}/dedies. - Limites de debit -- Consultez Limites de debit et quotas.
Obtenir l'acces complet
La reference API interactive avec les schemas complets de requete/reponse, la documentation des parametres et un environnement sandbox est disponible pour les clients. Contactez-nous pour obtenir des identifiants.