Ugrás a fő tartalomra

Platform API referencia

A vitalera REST API 148 végpontot tesz elérhetővé 20+ erőforráscsoportban, a vitális jelek bevitelétől a gondozási terv életciklus-kezeléséig. Minden végpont JSON-t ad vissza, és RESTful konvenciókat követ FHIR R5-hez igazított adatmodellekkel.

Teljes API dokumentáció

Az interaktív API referencia kérés/válasz sémákkal, paraméter-részletekkel és példa payload-okkal az ügyfelek számára elérhető a vitalera dashboard-ban. Lépjen kapcsolatba az info@vitalera.io címmel a hozzáférésért.

Hitelesítés és felhasználók

CsoportVégpontokLeírás
JWT hitelesítés4JWT tokenek generálása, frissítése, érvényesítése és deaktiválása
Integrációs hitelesítés1SSO átirányítás külső identitásszolgáltatókhoz
Hitelesítő adatok kezelése1Alkalmazás ügyfél-hitelesítő adatok rotálása
Felhasználók és jogosultságok1Aktuális felhasználói jogosultságok és szerepkör-információk

Résztvevők

CsoportVégpontokLeírás
Monitorozottak (betegek)10Résztvevők létrehozása, listázása, frissítése, törlése. Listák exportálása, összefoglalók lekérése, gondozási hozzárendelések kezelése és alapértelmezett tervek lekérdezése.
Szakemberek5Egészségügyi szakemberek és gondozói csapattagok létrehozása, listázása, frissítése, törlése.
Monitorozó csapatok1Monitorozó csapattagok listázása tervdefiníció szerint.
Összefoglalók1Összesített számlálók a monitorozott résztvevők között.

Gondozási tervek és feladatok

CsoportVégpontokLeírás
Tervdefiníciók11Tervsablonok kezelése — listázás, lekérés, publikálás, visszavonás, felülvizsgálat. Akciók, alkalmazásbeállítások, szervezetek, profilmezők és érvényesítési állapot lekérdezése.
Monitorozott tervek26Teljes életciklus-kezelés — létrehozás, aktiválás, felfüggesztés, folytatás, befejezés, visszavonás. Monitorozó csapattagok, felülbírálatok, triggerek, eltérések, egyéni mezők kezelése és PDF jelentések generálása.
Feladatok10Klinikai és wellness feladatok kezelése — listázás, elfogadás, indítás, befejezés, törlés, meghiúsulás, elutasítás. Függőben lévő feladatszámlálók irányítópult-jelvényekhez.

Megfigyelések — Vitális jelek

CsoportVégpontokLeírás
Vérnyomás2Szisztolés, diasztolés és átlagos artériás nyomás
Pulzus2Folyamatos és alkalmankénti pulzusmérések
Oxigénszaturáció (SpO2)2Pulzoximéteres mérések
Hőmérséklet2Testhőmérséklet-mérések
Koleszterin2Össz-, LDL-, HDL-koleszterin panelek

Megfigyelések — Aktivitás és fitnesz

CsoportVégpontokLeírás
Lépésszám2Napi és napközi lépésadatok
Kalóriák2Aktív és összes kalóriafelhasználás
Távolság2Megtett távolság (séta, futás, kerékpározás)
Emeletek2Szintemelkedés és emeletek
Aktív percek2Napi aktív percek intenzitási zónák szerint
Edzések2Strukturált edzésfoglalkozások körökkel, HR zónákkal, tempóval
VO2 Max2Becsült maximális oxigénfelvétel

Megfigyelések — Alvás és felépülés

CsoportVégpontokLeírás
Alvási foglalkozások3Alvás időtartama, hatékonysága és foglalkozás-metaadatok
Alvási fázisok2Könnyű, mély, REM és éber fázis-bontások
Alvási légzés2Légzési gyakoriság és zavarok alvás közben
Stressz-pontszám2Napi stresszszintek és trendek
Felépülési pontszám2Edzés utáni felépülési készenlét
Terhelési pontszám2Kardiovaszkuláris terhelés az aktivitástól
Energiaszint2Body Battery / energiatartalék szintek

Megfigyelések — Specializált

CsoportVégpontokLeírás
Vércukor2Alkalmankénti vércukormérések
CGM mérések2Folyamatos glükózmonitorozási adatpontok
CGM összefoglalók2Tartományban töltött idő, átlagos glükóz, variabilitás
CGM riasztások2Magas/alacsony glükóz riasztási események
HRV2Szívfrekvencia-variabilitás (RMSSD, SDNN)
ECG2Elektrokardiogram hullámforma-adatok
Testösszetétel2Súly, testzsír %, izomtömeg, BMI
Bőrhőmérséklet2Folyamatos bőrhőmérséklet-mérések
Csúcs kilégzési áramlás2Asztma és COPD monitorozás
Légzési frekvencia2Légzési frekvencia mérések
Spirometria2FEV1, FVC és egyéb tüdőfunkciós metrikák
Mentális egészség4Hangulatállapot-követés és értékelési pontszámok

Megfigyelések — Általános

CsoportVégpontokLeírás
Adatminőség1Megfigyelési adatfolyamok minőségi metrikái
FIT fájl feltöltés1Nyers Garmin FIT fájlok feltöltése feldolgozásra
Garmin alvás1Közvetlen Garmin Sleep API adatbevitel
Garmin hiányok1Garmin adatfolyamok hiányainak azonosítása

Kérdőívek

CsoportVégpontokLeírás
Kérdőívek4Kérdőívek listázása, részletek lekérése, elemek fordításokkal (Accept-Language) és válaszok lekérdezése.

Riasztások

CsoportVégpontokLeírás
Észlelt problémák7Riasztások osztályozása, törlése vagy tévesen bevittként jelölése. Osztályozási részletek frissítése. Aktivált riasztások lekérdezése.

Időpontok

CsoportVégpontokLeírás
Időpontok6Teljes ütemezési életciklus — foglalás, bejelentkezés, teljesítés, lemondás, meg nem jelenés, hibás jelölés.

Eszközintegrációk

CsoportVégpontokLeírás
Fitbit4Fitbit fiókok összekapcsolása/szétkapcsolása, kapcsolat állapotának ellenőrzése, utolsó szinkronizálási idő lekérdezése.
Garmin1Közvetlen Garmin adatbeviteli végpontok.

Tartalom

CsoportVégpontokLeírás
Könyvtár1Oktatási és tájékoztató tartalom-erőforrások listázása.

Alap URL

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

Hitelesítés

Minden végpont érvényes JWT Bearer tokent igényel. Lásd a Platform API hitelesítés oldalt.

Gyakori minták

  • Lapozás — A lista végpontok lapozott eredményeket adnak vissza count, next és previous mezőkkel.
  • Szűrés — A legtöbb lista végpont támogatja a lekérdezési paramétereket állapot, dátum és erőforrás-specifikus mezők szerinti szűréshez.
  • Fordítások — A fordítható tartalmú erőforrások támogatják az Accept-Language fejlécet.
  • Állapotátmenetek — Az életciklussal rendelkező erőforrások (feladatok, tervek, időpontok, riasztások) dedikált POST /{id}/{action}/ végpontokat használnak.
  • Sebességkorlátok — Lásd a Sebességkorlátok és kvóták oldalt.

Teljes hozzáférés

Az interaktív API referencia teljes kérés/válasz sémákkal, paraméter-dokumentációval és sandbox környezettel az ügyfelek számára elérhető. Lépjen velünk kapcsolatba hitelesítő adatokért.