Plattforms-API-referens
vitalera REST API exponerar 148 aendpunkter oever 20+ resursgrupper, fraan intag av vitala tecken till livscykelhantering av vaardplaner. Alla aendpunkter returnerar JSON och foeljer RESTful-konventioner med FHIR R5-anpassade datamodeller.
Fullstaendig API-dokumentation
Den interaktiva API-referensen med begaeran/svarsscheman, parameterdetaljer och exempelpayloads aer tillgaenglig foer kunder i vitalera dashboard. Kontakta info@vitalera.io foer aatkomst.
Autentisering och anvaendare
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| JWT-autentisering | 4 | Generera, foernya, validera och avaktivera JWT-tokens |
| Integrationsautentisering | 1 | SSO-omdirigering foer externa identitetsleverantoerer |
| Hantering av uppgifter | 1 | Rotera applikationens klientuppgifter |
| Anvaendare och behoergheter | 1 | Aktuell anvaendares behoergheter och rollinformation |
Deltagare
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Monitorerade (patienter) | 10 | Skapa, lista, uppdatera, radera deltagare. Exportera listor, haemta sammanfattningar, hantera vaardtilldelningar och fraagestandardplaner. |
| Professionella | 5 | Skapa, lista, uppdatera, radera vaardpersonal och vaardteammedlemmar. |
| Oevervakningsteam | 1 | Lista oevervakningsteammedlemmar efter plandefinition. |
| Sammanfattningar | 1 | Aggregerade raeeknare oever monitorerade deltagare. |
Vaardplaner och uppgifter
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Plandefinitioner | 11 | Hantera planmallar — lista, haemta, publicera, dra tillbaka, revidera. Fraaega aatgaeerder, appinstaellningar, organisationer, profilfoaelt och valideringsstatus. |
| Monitorerade planer | 26 | Fullstaendig livscykelhantering — skapa, aktivera, pausera, aateruppta, slutfoera, aaaterkalla. Hantera oevervakningsteammedlemmar, oeversidanden, triggers, avvikelser, anpassade foaelt och generera PDF-rapporter. |
| Uppgifter | 10 | Hantera kliniska och wellnessuppgifter — lista, acceptera, starta, slutfoera, avbryta, misslyckas, avvisa. Vaentande uppgiftsraeeknare foer instrumentpanelmaerken. |
Observationer — Vitala tecken
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Blodtryck | 2 | Systoliskt, diastoliskt och medelartaertryck |
| Puls | 2 | Kontinuerliga och punktmaetningar av puls |
| Syresaettnad (SpO2) | 2 | Pulsoximetermaetningar |
| Temperatur | 2 | Kroppstemperaturmaetningar |
| Kolesterol | 2 | Total-, LDL-, HDL-kolesterolpaneler |
Observationer — Aktivitet och trening
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Stegraeeknare | 2 | Daglig och intradagsdata foer steg |
| Kalorier | 2 | Aktiv och total kalorifoebraenning |
| Avstaand | 2 | Tillryggalagd avstaand (gaang, loepning, cykling) |
| Vaanningar | 2 | Hoejdvinst och vaanningar |
| Aktiva minuter | 2 | Dagliga aktiva minuter efter intensitetszon |
| Traeningspass | 2 | Strukturerade traeningspass med varv, HR-zoner, tempo |
| VO2 Max | 2 | Uppskattat maximalt syreupptag |
Observationer — Soemn och aaterhaamtning
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Soemnsessioner | 3 | Soemnlaengd, effektivitet och sessionsmetadata |
| Soemnfaser | 2 | Laett, djup, REM och vaken fasuppdelning |
| Soemnandning | 2 | Andningsfrekvens och stoerningar under soemn |
| Stresspoaeng | 2 | Dagliga stressnivaaer och trender |
| Aaterhaamtningspoaeng | 2 | Beredskap foer aaterhaamtning efter traening |
| Belastningspoaeng | 2 | Kardiovaskulaer belastning fraan aktivitet |
| Energinivaer | 2 | Body Battery / energireservnivaaer |
Observationer — Specialiserade
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Blodglukos | 2 | Punktmaetningar av blodglukos |
| CGM-maetningar | 2 | Kontinuerliga glukosoeervakningsdatapunkter |
| CGM-sammanfattningar | 2 | Tid i intervall, genomsnittlig glukos, variabilitet |
| CGM-larm | 2 | Hoeg/laag glukosvarnigshaeendelser |
| HRV | 2 | Pulsvariabilitet (RMSSD, SDNN) |
| ECG | 2 | Elektrokardiogramvaagformdata |
| Kroppssammanstaellning | 2 | Vikt, kroppsfett %, muskelmassa, BMI |
| Hudtemperatur | 2 | Kontinuerliga hudtemperaturmaetningar |
| Maximalt utandningsfloede | 2 | Astma- och KOL-oeovervakning |
| Andningsfrekvens | 2 | Andningsfrekvensmaetningar |
| Spirometri | 2 | FEV1, FVC och andra lungfunktionsmaetvaerden |
| Mental haelsa | 4 | Humoeestillstaandsuppfoeljning och bedoemningspoaeng |
Observationer — Allmaenna
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Datakvalitet | 1 | Kvalitetsmaetvaerden foer observationsdatastroemmar |
| FIT-filuppladdning | 1 | Ladda upp raaa Garmin FIT-filer foer bearbetning |
| Garmin-soemn | 1 | Direkt Garmin Sleep API-dataintag |
| Garmin-luckor | 1 | Identifiera luckor i Garmin-datastroemmar |
Enkaeters
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Enkaeters | 4 | Lista enkaeters, haemta detaljer, haemta objekt med oeversaettningar (Accept-Language) och fraagestandardsvar. |
Larm
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Upptaeckta problem | 7 | Klassificera, avbryta eller markera larm som felinmatade. Uppdatera klassificeringsdetaljer. Fraaega utloesta larm. |
Tidsbokning
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Tidsbokning | 6 | Fullstaendig schemalagningslivscykel — boka, checka in, slutfoera, avboka, uteblivande, felmarkering. |
Enhetsintegrationer
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Fitbit | 4 | Laenka/avlaenka Fitbit-konton, kontrollera laenkstatus, fraaega senaste synktid. |
| Garmin | 1 | Direkta Garmin-dataintags-aendpunkter. |
Innehaall
| Grupp | Aendpunkter | Beskrivning |
|---|---|---|
| Bibliotek | 1 | Lista utbildnings- och informationsinnehåallsresurser. |
Bas-URL
https://api.vitalera.io/api/
Autentisering
Alla aendpunkter kraever en giltig JWT Bearer-token. Se Plattforms-API-autentisering.
Vanliga moenster
- Paginering — Listaendpunkter returnerar paginerade resultat med foaelten
count,nextochprevious. - Filtrering — De flesta listaendpunkter stoedjer fraageparametrar foer filtrering efter status, datum och resursspecifika foaelt.
- Oeversaettningar — Resurser med oeversaettbart innehaall stoedjer
Accept-Language-huvudet. - Tillstaandsoevergaangar — Resurser med livscykler (uppgifter, planer, tidsbokningar, larm) anvaender dedikerade
POST /{id}/{action}/-aendpunkter. - Hastighetsbegraeensningar — Se Hastighetsbegraeensningar och kvoter.
Faa fullstaendig aatkomst
Den interaktiva API-referensen med fullstaendiga begaeran/svarsscheman, parameterdokumentation och en sandbox-miljoe aer tillgaenglig foer kunder. Kontakta oss foer uppgifter.