一、采样数据接口
1.1 查询时间段内的采样数据集
A. 接口说明
| 功能介绍 | 查询指定时间段内的采样数据集 |
| 场景描述 | 指定开始时间和结束时间,返回指定采集器在该时间段内的采样数据集。 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/dataSources/dataSets?sourceId=***&limit=***&startTime=***&endTime=&limit=***&cursor=*** |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json; |
C. 查询参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| sourceId | String | 是 | 数据源的唯一标识。 | |
| startTime | Long | 是 | 所有采样点的最小开始时间。单位:毫秒 | |
| endTime | Long | 是 | 所有采样点的最大开始时间。单位:毫秒;开始时间和结束时间不超过30天 | |
| cursor | String | 否 | 分页标识。填入上一个请求的cursor值进行后续查询。 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| sourceId | String | 是 | 数据采集器的唯一标识。 | |
| startTime | Long | 是 | 所有采样点的最小开始时间。单位:毫秒 | |
| endTime | Long | 是 | 所有采样点的最大开始时间。单位:毫秒 | |
| dataPoints | List<DataPoint> | 是 | 采样点DataPoint列表。请参见 DataPoint 数据模型。 | |
| cursor | String | 否 | 分页标识。填入上一个请求的 cursor 值进行后续查询。 | |
| hasMore | Boolean | 否 | 是否还有数据待拉取 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/dataSources/dataSets?clientId=123456&limit=20&userId=1224&sourceId=lnaF9oZWFydF9yYXRlLmhlYWx0aDpjb20ueGlhb21pLmhlYWx0aDpYSUFPTUk6dW5rbm93bjpobHRoLmdlbl&startTime=1675749600000&endTime=1675769600000F. 响应示例
{
"startTime": 1748242182165,
"endTime": 1748442858000,
"sourceId": "lnaF9oZWFydF9yYXRlLmhlYWx0aDpjb20ueGlhb21pLmhlYWx0aDpYSUFPTUk6dW5rbm93bjpobHRoLmdlbl",
"cursor": 128068289036290,
"hasMore": true,
"dataPoints": [{
"dataTypeName": "com.xiaomi.steps.delta",
"startTime": 1675752300000,
"endTime": 1675752300000,
"value": [
{
"fieldName": "steps_delta",
"integerValue": 7
}
],
"modifyTime": 1675765099000,
"zoneName": "Asia/Shanghai"
},
{
"dataTypeName": "com.xiaomi.steps.delta",
"startTime": 1675752360000,
"endTime": 1675752360000,
"value": [
{
"fieldName": "steps_delta",
"integerValue": 80
}
],
"modifyTime": 1675765099000,
"zoneName": "Asia/Shanghai"
}]
}1.2 查询数据类型的采样数据
A. 接口说明
| 功能介绍 | 根据给定时间段获取特定数据类型或数据采集器对应时间段内的采样数据明细。 |
| 场景描述 | 指定时间段,查询特定的数据类型,根据一定的融合规则返回对应时间段的采样数据明细; 指定时间段,查询特定的数据采集器,返回该采集器对应时间段的采样数据明细。 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/dataSources/dataPoints |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| startTime | Long | 是 | 开始时间。单位:毫秒 | |
| endTime | Long | 是 | 结束时间。单位:毫秒;endTime与startTime时间间隔不能超过30天。 | |
| dataTypeName | string | 是 | 数据类型; | |
| cursor | string | 否 | 分页标识。填入上一个请求的cursor值进行后续查询。 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| group | List<Group> | 是 | 汇总数据的组列表。请参见 Group | |
| cursor | string | 否 | 分页标识。下次查询的分页标识。(长度1~1000位) | |
| hasMore | Boolean | 否 | 是否还有数据待拉取 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/dataSources/dataPoints?userId=123&clientId=12345&dataTypeName=com.xiaomi.steps.delta&startTime=1675749600000&endTime=1675769600000F. 响应示例
{
"group": [{
"startTime": 1675749600,
"endTime": 1675769600,
"dataSet": [
{
"dataPoints": [
{
"dataTypeName": "com.xiaomi.steps.delta",
"startTime": 1675752300000,
"endTime": 1675752300000,
"value": [
{
"fieldName": "steps_delta",
"integerValue": 7
}
]
}
]
},
{
"dataPoints": [
{
"dataTypeName": "com.xiaomi.steps.delta",
"startTime": 1675752360000,
"endTime": 1675752360000,
"value": [
{
"fieldName": "steps_delta",
"integerValue": 18
}
]
}
]
},
{
"dataPoints": [
{
"dataTypeName": "com.xiaomi.steps.delta",
"startTime": 1675764900000,
"endTime": 1675764900000,
"value": [
{
"fieldName": "steps_delta",
"integerValue": 1
}
]
}
]
}
]
}],
"cursor": "1pEwMzE3MDAwMDAwMDAwMDAwIiwicyI6MTY3NTc1NjgwMH"
}1.3 采样数据多日统计查询
A. 接口说明
| 功能介绍 | 将特定数据类型数据以天为单位按一定规则进行聚合查询。 |
| 场景描述 | 指定采样数据以天为单位进行聚合查询。 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/aggregate/dailies |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 查询参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| startDay | String | 是 | 期望被聚合的数据开始日期。单位:天;格式为yyyyMMdd,例:20250101 | |
| endDay | String | 是 | 期望被聚合的数据结束日期。单位:天;格式为yyyyMMdd,例:20250101;endDay与startDay时间间隔不能超过7天。 | |
| dataTypes | List<String> | 是 | 数据明细类型集合;List最大容量:10。 | |
| zoneName | String | 是 | 时区信息。格式:Asia/Shanghai。 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| group | List<Group> | 是 | 汇总数据的组列表。请参见 Group |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/aggregate/dailies?startDay=20230322&endDay=20230325&dataTypes=com.xiaomi.steps.total&zoneName=Asia/Shanghai&userId=123&clientId=1234F. 响应示例
{
"group": [{
"startTime": 1679673600000,
"endTime": 1679759999000,
"dataSet": [{
"dataPoints": [{
"dataTypeName": "com.xiaomi.steps.total",
"startTime": 1679673600000,
"endTime": 1679759999000,
"value": [
{
"fieldName": "steps",
"integerValue": 11
}
]
}]
}]
}]
}1.4 查询最新采样数据
A. 接口说明
| 功能介绍 | 查询指定数据类型最新采样数据点 |
| 场景描述 | 指定数据类型,查询指定数据类型最新的采样数据点。若指定的数据类型没有相关的采样数据点,则不返回。 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/dataSources/latestDataPoint |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 查询参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| dataTypes | List<String> | 是 | 数据类型名称。最少查询一个,最多查询 5 个。 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| dataPoints | List<DataPoint> | 是 | 采样点DataPoint列表。请参见 DataPoint 数据模型。 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/dataSources/latestDataPoint?&userId=123&clientId=1234&dataTypes=com.xiaomi.steps.deltaF. 响应示例
{
"dataPoints": [{
"dataTypeName": "com.xiaomi.steps.delta",
"startTime": 1747390560000,
"endTime": 1747390560000,
"value": [
{
"fieldName": "steps_delta",
"integerValue": 31
}
],
"modifyTime": 1747481514000,
"originDataSourceId": "hlth.gen_126286130315265",
"zoneName": "Asia/Shanghai"
}]
}1.5 活力指标统计数据查询
A. 接口说明
| 功能介绍 | 将活力指标以天为单位按一定规则进行查询。 |
| 场景描述 | 查询活力指标。 |
| 使用约束 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/goalSummary |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 查询参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| startDay | String | 是 | 期望被聚合的数据开始日期。单位:天;格式为yyyyMMdd,例:20250101 | |
| endDay | String | 是 | 期望被聚合的数据结束日期。单位:天;格式为yyyyMMdd,例:20250101;endDay与startDay时间间隔不能超过 7 天。 | |
| zoneName | String | 是 | 时区信息。格式:Asia/Shanghai。 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| goalSummary | List<DataPoint> | 是 | 采样点DataPoint列表。请参见 DataPoint 数据模型。 | |
| startTime | Long | 是 | 所有采样点的最小开始时间。单位:毫秒 | |
| endTime | Long | 是 | 所有采样点的最大开始时间。单位:毫秒;开始时间和结束时间不超过30天 | |
| zoneName | String | 是 | 时区信息。格式:Asia/Shanghai。 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/goalSummary?&userId=123&clientId=1234&startDay=20230321&endDay=20230323&zoneName=Asia/ShanghaiF. 响应示例
{
"startTime": 1679356800000,
"endTime": 1679529600000,
"goalSummary": [
{
"dataTypeName": "com.xiaomi.goal.summary",
"startTime": 1679356800000,
"endTime": 1679356800000,
"value": [
{
"fieldName": "calories_total",
"integerValue": 52
},
{
"fieldName": "calories_goal",
"integerValue": 100
},
{
"fieldName": "steps",
"integerValue": 2732
},
{
"fieldName": "steps_goal",
"integerValue": 1000
},
{
"fieldName": "active_times"
},
{
"fieldName": "active_goal",
"integerValue": 2
}
]
}
]
}二、健康记录接口
2.1 查询时间段内的健康记录
A. 接口说明
| 功能介绍 | 查询指定时间段内的健康记录。 |
| 场景描述 | 指定开始时间和结束时间,返回指定数据源在该时间段内的健康记录。 |
| 使用约束 | 无。 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/healthRecords/duration?sourceId=***startTime=&endTime=&limit=***&cursor=*** |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| sourceId | String | 是 | 数据源的唯一标识。 | |
| startTime | Long | 是 | 开始时间。13位整数的时间戳,单位:毫秒。startTime时间早于endTime时间。startTime/endTime同时为非空字符串时生效,否则不生效。 | |
| endTime | Long | 是 | 结束时间。13位整数的时间戳,单位:毫秒。startTime时间早于endTime时间,endTime与startTime时间间隔不能超过30天。 | |
| cursor | String | 否 | 分页标识。填入上一个请求的cursor值进行后续查询。 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| healthRecords | List<HealthRecords> | 是 | 健康记录HealthRecord列表。请参见HealthRecords数据模型。 | |
| cursor | String | 否 | 分页标识。填入上一个请求的 cursor 值进行后续查询。 | |
| hasMore | Boolean | 否 | 是否还有数据待拉取 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/healthRecords/duration?sourceId=lnaF9oZWFydF9yYXRlLmhlYWx0aDpjb20ueGlhb21pLmhlYWx0aDpYSUFPTUk6dW5rbm93bjpobHRoLmdlbl&clientId=1234&userId=123&startTime=1747642342000&endTime=1747642342200F. 响应示例
{
"startTime": 1748542182165,
"endTime": 1748542182165,
"sourceId": "lnaF9oZWFydF9yYXRlLmhlYWx0aDpjb20ueGlhb21pLmhlYWx0aDpYSUFPTUk6dW5rbm93bjpobHRoLmdlbl",
"cursor": 127331176808452,
"hasMore": true,
"healthRecords": [{
"dataTypeName": "com.xiaomi.steps.delta",
"startTime": 1748542182165,
"endTime": 1748542182165,
"value": [
{
"fieldName": "steps",
"integerValue": 100
},
{
"fieldName": "calories",
"integerValue": 100
},
{
"fieldName": "distance",
"floatValue": 100
}
],
"modifyTime": 1748315673,
// 睡眠记录包含subData:分段睡眠
"subData": {
"com.xiaomi.sleep_state.delta": {
"startTime": 1767794402000,
"endTime": 1767837984000,
"dataPoints": [
{
"dataTypeName": "com.xiaomi.sleep_state.delta",
"startTime": 1767794402000,
"endTime": 1767837984000,
"value": [
{
"fieldName": "sleep_state",
"integerValue": 6
}
]
}
]
}
}
}]
}2.2 查询数据类型的健康记录
A. 接口说明
| 功能介绍 | 查询指定时间段内数据类型的健康记录。 |
| 场景描述 | 指定开始时间和结束时间以及数据类型,返回指定数据类型在该时间段内的健康记录。 |
| 使用约束 | 无。 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/healthRecords?startTime=&endTime=&dataTypeName=&cursor=*** |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| startTime | Long | 是 | 开始时间。13位整数的时间戳,单位:毫秒。startTime时间早于endTime时间。startTime/endTime同时为非空字符串时生效,否则不生效。 | |
| endTime | Long | 是 | 结束时间。13位整数的时间戳,单位:毫秒。startTime时间早于endTime时间,endTime与startTime时间间隔不能超过30天。 | |
| dataTypeName | string | 是 | 数据类型名称。 | |
| cursor | String | 否 | 分页标识。填入上一个请求的cursor值进行后续查询。 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| healthRecords | List<HealthRecords> | 是 | 健康记录HealthRecord列表。请参见 DataPoint 数据模型。 | |
| cursor | String | 否 | 分页标识。填入上一个请求的 cursor 值进行后续查询。 | |
| hasMore | Boolean | 否 | 是否还有数据待拉取 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/healthRecords?&userId=123&clientId=1234&startTime=1687156700000&endTime=1687156800000&dataTypeName=com.xiaomi.high_heart_rate.healthF. 响应示例
{
"startTime": 1687156700000,
"endTime": 1687156800000,
"healthRecords": [{
"dataTypeName": "com.xiaomi.high_heart_rate.health",
"startTime": 1687156700000,
"endTime": 1687156760000,
"value": [
{
"fieldName": "threshold",
"integerValue": 0
},
{
"fieldName": "avg_heart_rate",
"integerValue": 105
},
{
"fieldName": "max_heart_rate",
"integerValue": 115
},
{
"fieldName": "min_heart_rate",
"integerValue": 101
}
],
"modifyTime": 1687156933000,
// 睡眠记录包含subData:分段睡眠
"subData": {
"com.xiaomi.sleep_state.delta": {
"startTime": 1767794402000,
"endTime": 1767837984000,
"dataPoints": [
{
"dataTypeName": "com.xiaomi.sleep_state.delta",
"startTime": 1767794402000,
"endTime": 1767837984000,
"value": [
{
"fieldName": "sleep_state",
"integerValue": 6
}
]
}
]
}
}
}]
}三、运动记录接口
3.1 查询时间段内的运动记录
A. 接口说明
| 功能介绍 | 查询用户已创建的运动记录列表。 |
| 场景描述 | 查询指定时间段内的运动记录。 根据cursor增量查询运动记录。 |
| 使用约束 | 无。 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/sportRecords?startTime=***&endTime=***&sportKey=***&cursor=*** |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| startTime | Long | 是 | 开始时间。13位整数的时间戳,单位:毫秒。startTime时间早于endTime时间。startTime/endTime同时为非空字符串时生效,否则不生效。 | |
| endTime | Long | 是 | 结束时间。13位整数的时间戳,单位:毫秒。startTime时间早于endTime时间,endTime与startTime时间间隔不能超过30天。 | |
| sportKey | String | 是 | 运动类型 key | |
| cursor | String | 否 | 分页标识 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| sportRecords | List<SportRecord> | 否 | 开始/结束时间范围内的运动记录列表。请参见 SportRecord 数据模型。 | |
| cursor | String | 否 | 仅当hasMoreData返回值为true时返回。 | |
| hasMore | Boolean | 否 | 是否还有数据待拉取 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/sportRecords?startTime=1728610395000&endTime=1728631995000&sportKey=outdoor_running&userId=123&clientId=1234F. 响应示例
{
"sportRecords": [{
"startTime": 1728613796000,
"endTime": 1728613856000,
"zoneName": "Asia/Shanghai",
"sportKey": "indoor_running",
"sourceId": "xxxxxx",
"sportTime": 130, //有效运动时长:秒
"sportSummary": {
"dataSummary": [
{
"dataTypeName": "com.xiaomi.steps.total",
"startTime": 1728631832,
"endTime": 1728632031,
"value": [
{
"fieldName": "steps",
"integerValue": 509
}
]
},
{
"dataTypeName": "com.xiaomi.steps_rate.statistics",
"startTime": 1728631832,
"endTime": 1728632031,
"value": [
{
"fieldName": "max",
"floatValue": 192
}
]
},
{
"dataTypeName": "com.xiaomi.exercise_heart_rate.statistics",
"startTime": 1728631832,
"endTime": 1728632031,
"value": [
{
"fieldName": "avg",
"floatValue": 151
},
{
"fieldName": "max",
"floatValue": 171
},
{
"fieldName": "min",
"floatValue": 113
}
]
}
],
"paceSummary": {
"maxPace": 214,
"minPace": 737
}
},
"sportId": "01EiV7NMXYZdWLBMQrqknmhcgd2uL89JbXt_syl-navXMTXHFcocJcOLg4bM-Z8J-lMJA1LCvL7W6Vrpdyyd_Vt8mGT0svoqlW_AOO1j-4A"
}
]}3.2 查询时间段内的运动记录[全量]
A. 接口说明
| 功能介绍 | 查询用户已创建的运动记录列表。 |
| 场景描述 | 查询指定时间段内的运动记录。 根据cursor增量查询运动记录。 |
| 使用约束 | 无。 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/sportRecords/all?startTime=***&endTime=***&cursor=*** |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| startTime | Long | 是 | 开始时间。13位整数的时间戳,单位:毫秒。startTime时间早于endTime时间。startTime/endTime同时为非空字符串时生效,否则不生效。 | |
| endTime | Long | 是 | 结束时间。13位整数的时间戳,单位:毫秒。startTime时间早于endTime时间,endTime与startTime时间间隔不能超过30天。 | |
| cursor | String | 否 | 分页标识 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| sportRecords | List<SportRecord> | 否 | 开始/结束时间范围内的运动记录列表。请参见 SportRecord 数据模型。 | |
| cursor | String | 否 | 仅当hasMoreData返回值为true时返回。 | |
| hasMore | Boolean | 否 | 是否还有数据待拉取 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/sportRecords?startTime=1728610395000&endTime=1728631995000&sportKey=outdoor_running&userId=123&clientId=1234F. 响应示例
{
"sportRecords": [{
"startTime": 1728613796000,
"endTime": 1728613856000,
"zoneName": "Asia/Shanghai",
"sportKey": "indoor_running",
"sourceId": "xxxxxx",
"sportTime": 130, //有效运动时长:秒
"sportSummary": {
"dataSummary": [
{
"dataTypeName": "com.xiaomi.steps.total",
"startTime": 1728631832,
"endTime": 1728632031,
"value": [
{
"fieldName": "steps",
"integerValue": 509
}
]
},
{
"dataTypeName": "com.xiaomi.steps_rate.statistics",
"startTime": 1728631832,
"endTime": 1728632031,
"value": [
{
"fieldName": "max",
"floatValue": 192
}
]
},
{
"dataTypeName": "com.xiaomi.exercise_heart_rate.statistics",
"startTime": 1728631832,
"endTime": 1728632031,
"value": [
{
"fieldName": "avg",
"floatValue": 151
},
{
"fieldName": "max",
"floatValue": 171
},
{
"fieldName": "min",
"floatValue": 113
}
]
}
],
"paceSummary": {
"maxPace": 214,
"minPace": 737
}
},
"sportId": "01EiV7NMXYZdWLBMQrqknmhcgd2uL89JbXt_syl-navXMTXHFcocJcOLg4bM-Z8J-lMJA1LCvL7W6Vrpdyyd_Vt8mGT0svoqlW_AOO1j-4A"
}
]}3.3 查询运动详情
A. 接口说明
| 功能介绍 | 上传指定运动记录的运动详情 |
| 场景描述 | 上传指定运动记录的运动详情 |
| 使用约束 | 无。 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/sportDetails |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| sportId | string | 是 | 运动记录sportId | |
| detailDataType | List<string> | 是 | 关联数据类型名称。 | |
| cursor | long | 否 | 分页标识;下次请求时携带 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| details | DataSet | 否 | 运动详情数据 | |
| cursor | long | 否 | 分页标识 | |
| hasMore | Boolean | 否 | 是否还有数据待拉取 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/sportDetails?sportId=kR9WW4hhMVHavyuHN_ABOA5XTwTGD-NtQrUVlNXMn7X0OeuxZdCc82mgSveCnJ2qxUA8rGdGxBJuyxMjrs-jTA&userId=123&clientId=1234&detailDataType=com.xiaomi.steps.deltaF. 响应示例
{
"cursor": 600,
"hasMore": true,
"details": [{
"dataPoints": [{
"dataTypeName": "com.xiaomi.steps.delta",
"startTime": 1749038446000,
"endTime": 1749038446999,
"value": [
{
"fieldName": "steps_delta",
"floatValue": 60
}
]
}]
}]
}3.4 查询运动目标
A. 接口说明
| 功能介绍 | 查询用户设置的运动目标值(目前开放的目标值有步数、卡路里、有效站立、中高强度活动)。 |
| 场景描述 | 查询用户设置的所有运动目标值 |
| 使用约束 | 无。 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/sportGoals |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数:无
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| goals | List<SportGoal> | 否 | steps-步数;calories-卡路里;intensity-中高强度;valid_stand-有效站立 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/sportGoals?&userId=123&clientId=1234F. 响应示例
{
"goals": [{
"goal": 500,
"key": "calories"
},
{
"goal": 6000,
"key": "steps"
},
{
"goal": 30,
"key": "intensity"
}]
}四、数据订阅接口
4.1 新增/更新订阅记录
A. 接口说明
| 功能介绍 | 新增/更新订阅记录 |
| 场景描述 | 记录订阅者、用户、事件之间的关联关系,表示订阅者关注了用户的某个事件。订阅记录由订阅记录ID唯一标识。 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS POST |
| 接口URL | https://hlthopen.io.mi.com/healthkit/subscribe/change |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| eventTypes | List<EventType> | 是 | 关注/订阅的事件列表 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| subscribeList | List<SubscribeInfo> | 否 |
E. 请求示例
{
curl --location 'https://hlthopen.io.mi.com/healthkit/subscribe/change?&userId=123' \
--header 'Authorization: xxxxxxx' \
--header 'Content-Type: application/json' \
--header 'X-Client-ID: 100000000' \
--data '{
"eventTypes": [
{
"eventType": "SPORT_RECORD_DATA_EVENT",
"subType": "UPDATE"
},
{
"eventType": "FITNESS_DATA_EVENT",
"subType": "UPDATE"
}
],
"userId":3150084830,
"clientId":100000000
}'F. 响应示例
{
"subscribeList": [{
"clientId": 100000000,
"subscriptionId": "dd1412a5-b9f8-11f0-984e-2ac0d734da02",
"openId": "2.0:uoBjLbWoqYgOkPuyo9GStHq9abc=",
"eventType": "SPORT_RECORD_DATA_EVENT",
"subType": "UPDATE"
},
{
"clientId": 100000000,
"subscriptionId": "dd14131e-b9f8-11f0-984e-2ac0d734da02",
"openId": "2.0:uoBjLbWoqYgOkPuyo9GStHq9abc=",
"eventType": "FITNESS_DATA_EVENT",
"subType": "UPDATE"
}]
}4.2 删除订阅记录接口
A. 接口说明
| 功能介绍 | 删除指定的订阅记录 |
| 场景描述 | 根据subscriptionId删除订阅记录 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS POST |
| 接口URL | https://hlthopen.io.mi.com/healthkit/subscribe/delBySubscriptionId |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| subscriptionId | String | 是 | 订阅记录ID |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| result | bool | 否 | 操作结果 |
E. 请求示例
curl --request POST \
--url 'https://hlthopen.io.mi.com/healthkit/subscribe/delBySubscriptionId?&userId=123' \
--header 'Authorization: xxxxxxx' \
--header 'Content-Type: application/json' \
--header 'X-Client-ID: 100000000' \
--data '{"subscriptionId":"e2194fcf-8899-11f0-b039-7afcac62cb42"}'F. 响应示例
{
"result": true
}4.3 按条件删除订阅记录
A. 接口说明
| 功能介绍 | 按条件删除指定的订阅记录 |
| 场景描述 | 根据eventType删除订阅记录 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS POST |
| 接口URL | https://hlthopen.io.mi.com/healthkit/subscribe/delByEventType |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| eventType | List<String> | 是 | 关注/订阅的事件,支持单个事件删除也支持多个事件删除。 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| result | bool | 是 | 是否删除成功 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/subscriptions?&userId=3150439767&clientId=1234&eventTypes=["FITNESS_AGGREGATED_DATA_EVENT"]F. 响应示例
{
"result": true
}4.4 查询订阅记录列表
A. 接口说明
| 功能介绍 | 查询订阅记录信息 |
| 场景描述 | 查询用户在应用上已注册的所有订阅记录信息。 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/subscribe/subscribeList |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数:无
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| subscribeList | List<SubscribeInfo> | 否 | 查询结果 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/subscribe/subscribeList?userId=3150439767&clientId=1234F. 响应示例
{
"subscribeList": [{
"clientId": 2882303761519792427,
"subscriptionId": "788f1691-78ec-11f0-b953-fa163e1d0a02",
"openId": "2.0:6gHgELWoqYgOlWQ7o9GStHq7nWE=",
"type": "FITNESS_AGGREGATED_DATA_EVENT",
"subType": "UPDATE"
},
{
"clientId": 2882303761519792427,
"subscriptionId": "788f1aa8-78ec-11f0-b953-fa163e1d0a02",
"openId": "2.0:6gHgELWoqYgOlWQ7o9GStHq7nWE=",
"type": "SPORT_RECORD_DATA_EVENT",
"subType": "UPDATE"
},
{
"clientId": 2882303761519792427,
"subscriptionId": "788f1ad3-78ec-11f0-b953-fa163e1d0a02",
"openId": "2.0:6gHgELWoqYgOlWQ7o9GStHq7nWE=",
"type": "FITNESS_DATA_EVENT",
"subType": "UPDATE"
}]
}4.5 订阅事件通知
A. 接口说明
| 功能介绍 | 当用户取消授权、运动记录发生变化以及原子数据变化时,通知开发者应用用户数据发生变更。 |
| 场景描述 | 数据订阅通知 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS POST |
| 接口URL | https://xxx/healthkit/notifications |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
- Request Header
| 参数 | 参数类型 | 是否必选 | 描述 |
| Content-Type | String | 是 | application/json |
| x-notification-signature | String | 是 | 签名:HMAC-SHA256 GenerateHMAC(openId_eventType_subType_eventTime, secret) |
// x-notification-signature 签名生成方式,secret为小米开放平台应用的AppSecret
// message为:openId_eventType_subType_eventTime
func GenerateHMAC(message, secret string) string {
h := hmac.New(sha256.New, []byte(secret))
h.Write([]byte(message))
signature := h.Sum(nil)
return hex.EncodeToString(signature)
}- Request Body
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| openId | String | 是 | 三方应用的用户标识 | |
| eventTime | Long | 是 | 事件发生时间 | |
| eventType | String | 是 | 事件类别 | |
| subType | String | 是 | 事件子类别 | |
| metaData | List<MetaData> | 是 | 事件扩展数据 |
D. 请求示例
{
"eventTime":1762841394065,
"eventType":"FITNESS_DATA_EVENT",
"subType":"UPDATE",
"metaData":[
{
"metaKey":"startTime",
"metaValue":"1606856007879"
},
{
"metaKey":"endTime",
"metaValue":"1606916007879"
},
{
"metaKey":"dataType",
"metaValue":"com.xiaomi.steps.delta"
}
],
"openId":""
}E. 响应示例
状态码为 200;
五、用户授权接口
5.1 三方取消授权
A. 接口说明
| 功能介绍 | 当用户取消授权接口 |
| 场景描述 | 无 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS POST |
| 接口URL | 测试:http://open.account.preview.n.xiaomi.net/user/unbindOAuth2Grained 线上:http://open.account.xiaomi.com/user/unbindOAuth2Grained |
| 数据格式 | 请求消息:application/x-www-form-urlencoded |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| access_token | String | 是 | ||
| client_id | String | 是 | 三方应用的用户标识 | |
| client_secret | String | 是 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| clientId | String | 是 | 三方应用的用户标识 | |
| openId | String | 是 | 用户openId | |
| unionId | String | 是 | ||
| deleteResult | int |
E. 请求示例
curl 'https://open.account.xiaomi.com/user/unbindOAuth2Grained' \
--compressed \
-X POST \
-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:139.0) Gecko/20100101 Firefox/139.0' \
-H 'Accept: */*' \
-H 'Accept-Language: zh-CN,zh;q=0.8,zh-TW;q=0.7,zh-HK;q=0.5,en-US;q=0.3,en;q=0.2' \
-H 'Accept-Encoding: gzip, deflate, br, zstd' \
-H 'content-type: application/x-www-form-urlencoded' \
-H 'Origin: moz-extension://62efe7ae-dd4f-468c-8613-90bbfd9457fe' \
-H 'Connection: keep-alive' \
-H 'Cookie: deviceId=wb_a692c63e-74d9-48b3-8b10-baa29dcb3182; _ga_XWN774PE8J=GS2.1.s1746615708$o8$g1$t1746615954$j0$l0$h0; _ga=GA1.1.102207318.1697539411; pass_ua=web; zhangluwenAccount=account; zhangluwenXiaomi=xiaomiTest; uLocale=zh_CN' \
-H 'Sec-Fetch-Dest: empty' \
-H 'Sec-Fetch-Mode: cors' \
-H 'Sec-Fetch-Site: same-origin' \
-H 'Priority: u=0' \
-H 'Pragma: no-cache' \
-H 'Cache-Control: no-cache' \
--data-raw 'access_token=V3_yJug6PIDAYwcuTJS84YnyhJwKTrS04Wx2sxMGGWzFVIwFW1aXpXsRimsbP0w2VqbPnL6svPpk42jTTThZWiNrPf_lvDQeR1Am4i3mQZy145KS1trhubLgoozGaKmI-BvlyuATs8Q7MLu_MixArqVVorQOFRyRSJOE7_lwhZHlRhu8Yns7gL9wp_DbORz2oAGXETeOO0aMEbhGP1IMtCkfw^&client_id=2882303761517326405^&client_secret=vjSvOUn4k0isaREYnDHQOQ=='F. 响应示例
- 判断是否解绑成功的唯一标志:code=0;
- 若失败,则会返回code、result、description可按需查看原因;
- 若成功,则会返回code、result、description和data,data的字段可按需获取;
{
"data": {
"clientId": "2882303761517326405",
"openId": "2.0:9/HBNgHaDlvtkG1rsZs3/jVcl4M=",
"unionId": "imePu1C_10gI9yQwwn3swNz4oPDC6J8m8OYU3E0w",
"deleteResult": 1
},
"result": "ok",
"code": 0,
"description": "no error",
"traceId": "fb7b2fdbf1ba1692f979c80e8ef26bab"
}5.2 查询用户授权信息
A. 接口说明
| 功能介绍 | 查询用户授权的信息 |
| 场景描述 | 无 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/profile/authorize |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| clientId | Long | 是 | 三方应用标识 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| AuthInfo | list<AuthInfo> | 是 | 授权信息 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/profile/authorize?&userId=3150439767&cliendId=2882303761519792427F. 响应示例
{
"authInfo": [{
"scopeId": 200033,
"scopeType": "read"
},
{
"scopeId": 200040,
"scopeType": "read"
},
{
"scopeId": 200041,
"scopeType": "read"
},
{
"scopeId": 200042,
"scopeType": "read"
},
{
"scopeId": 200046,
"scopeType": "read"
}]
}六、设备数据接口
6.1 查询用户当前绑定设备
A. 接口说明
| 功能介绍 | 查询用户当前绑定设备 |
| 场景描述 | 根据uid查询DataSource。 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/heathkit/deviceList |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数:无
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| bindList | List<BindList> | 否 | 集成各种传感器的硬件设备描述,例如:手表、手环等可穿戴设备。请参见 DeviceInfo 数据模型。 | 设备类型:仅支持手表/手环 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/deviceList?&userId=123&clientId=123456F. 响应示例
"bindList": [{
"bindInfo": {
"deviceName": "xx手环",
"updateTime": 1741657966543
"deviceCate": 1,
"productName": "xx手环",
"deviceId": "",
}
}]6.2 根据数据源获取设备信息
A. 接口说明
| 功能介绍 | 查询用户当前绑定设备 |
| 场景描述 | 根据sourceId查询设备信息 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/heathkit/deviceInfo |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| sourceId | String | 是 | sourceId数据源 |
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| bindInfo | BindInfo | 否 | 集成各种传感器的硬件设备描述,例如:手表、手环等可穿戴设备。请参见 BindInfo 数据模型。 |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/deviceInfo?sourceId=W5nOmNvbS54aWFvbWkuaGVhbHRoOlhJQU9NSTp1bmtub3duOjY0MTQzNDE1MzF. 响应示例
{
"code": 0,
"message": "ok",
"result": {
"bindInfo": {
"deviceName": "xx手环",
"updateTime": 1741657966543
"deviceCate": 1,
"productName": "xx手环",
"deviceId": "",
}
}
}七、个人信息接口
A. 接口说明
| 功能介绍 | 查询用户个人信息 |
| 场景描述 | 无 |
| 使用约束 | 无 |
B. 接口原型
| 承载协议 | HTTPS GET |
| 接口URL | https://hlthopen.io.mi.com/healthkit/profile/userInfo |
| 数据格式 | 请求消息/响应消息:Content-Type: application/json |
C. 请求参数:无
D. 响应参数
| 参数 | 参数类型 | 是否必选 | 描述 | 备注 |
| height | float64 | 否 | 身高信息,单位:cm | |
| weight | float64 | 否 | 体重信息,单位:kg |
E. 请求示例
https://hlthopen.io.mi.com/healthkit/profile/userInfo?&userId=3150439767&cliendId=2882303761519792427F. 响应示例
{
"height": 165,
"weight": 51.40
}