Health API (Beta)

Owned by An Nguyen
Last updated: Apr 11, 2024 by Anton Tolkachiov
2 min read

Device list

 

 

Device category

Device name

Device type

Pulse, Oximeter

Pulse Oximeter PO3M

ihealth_po_po3

 

 

 

 

Scale

Scale HS2S

ihealth_scale_hs22

 

 

 

 

Active Minutes, Steps

Apple Health

applehealth

Samsung Health

samsunghealth

 

 

 

 

Blood Pressure

Blood Pressure RPM-BP100

welchallync_bp_bp100

 

 

Glucose Meters

Glucose Meters Gluco+/BG5S

ihealth_bg_bg5s

 

 

 

 

Thermometer

Thermometer PT3SBT

ihealth_thermometer_pt3sbt

 

 

 

 

Data classifications

Data

Data Class

Data Type

Unit

Unit value

Type

Range

Data

Data Class

Data Type

Unit

Unit value

Type

Range

1

Temperature

body

temperature_body

temperature_unit

cel | fah

float

 

2

Blood Glucose

body

bg

bg_unit

mg/dL | mmol/L

 

 

3

Blood Pressure

body

hp, lp

bp_unit

mmHg | kPa

int

 

4

Weight

body

weight

weight_unit

lbs | kg

float

 

5

Active Minutes

body

active_minutes

 

 

int

 

6

Steps

body

steps

 

 

int

 

7

Pulse

body

hr

 

 

float

 

8

Blood Oxygen

body

bo

 

 

float

 

9

Illuminance

environment

illuminance

illuminance_unit

lux

 

 

10

Humidity

environment

humidity

humidity_unit

percentage

 

 

11

Gas

environment

gas

 

 

 

 

12

Movement

environment

movement

movement

TBD

boolean | int

0 | 1

13

Noise

environment

noise

noise_unit

TBD

float

0.0 - 1.0

14

Range

environment

range

range_unit

cm

float

2-400 cm

APIs

POST /users/{user_id}/devices

Device registration

Parameters

Parameter

Type

Description

Parameter

Type

Description

X-AccountCode

Header

 

X-ApiKey

Header

 

X-ApiToken

Header

 

device_id

String

Device unique ID

device_name

String

Device name (in device table)

type

String

Device type (in device table)

E.g.

request: POST https://api.vseepreview.com/vc/stable/api_v3/users/905/devices headers: { "X-AccountCode": "vclinic", "X-ApiKey": "vclinic_api_secret", "X-ApiToken": "vclinic_api_token" } parameters: { "device_id": "004D320DCAA2", "device_name": "Thermometer PT3SBT", "type": "ihealth_thermometer_pt3sbt" }

 

POST /api_v3/health

Parameters

Parameter

Type

Description

Parameter

Type

Description

X-AccountCode

Header

 

X-ApiKey

Header

 

X-ApiToken

Header

 

type

String

Device type (in device table)

date

String

Recorded date (yyyy-mm-dd)

time

Int

Unix timestamp

device_id

String

Device unique ID

data_type

String

Data type (in data table)

data_class

String

 

Data Value

String

Data type = value

Data Unit

String

Data unit = unit value

E.g.

request: POST https://api.vseepreview.com/vc/stable/api_v3/health headers: { "X-AccountCode": "vclinic", "X-ApiKey": "vclinic_api_key", "X-ApiToken": "vclinic_api_token" } parameters: { "type": "ihealth_thermometer_pt3sbt", "date": "2021-08-25", "time": 1695626540, "device_id": "004D320DCAA2", "data_type": "temperature_body", "data_class": "body", "temperature_body": "36.76", "temperature_unit": "cel" }

parameters for blood glucose

"data_type": "bg", "bg": 100, "bg_unit": "mg/dL"

parameters for blood pressure

parameters for weight

parameters for active minutes & steps

parameters for pulse & blood oxygen