数据采集器即DataCollector,可以采集传感器的原始数据,也可以采集经过转换或合并后的派生数据。
创建一个数据采集器,数据采集器的ID是由请求体中的某些字段根据一定规则组合生成的,并且每个数据采集器的ID在该用户下是唯一的。
| 承载协议 | HTTPS POST |
|---|---|
| 接口方向 | 开发者应用->Health Service Kit云 |
| 接口URL | https://health-api.cloud.huawei.com/healthkit/v2/dataCollectors |
| 数据格式 | 请求消息:Content-Type: application/json 响应消息:Content-Type: application/json |
Request Header
| 参数 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Content-type | String | 是 | 取值为:application/json; charset=UTF-8 |
| Authorization | String | 是 | 请参见认证鉴权。 说明: Bearer后面拼接空格,再拼接获取的access_token。 |
| x-client-id | String | 否 | 开发者联盟分配的应用标识。服务端可以基于其进行灰度路由,建议携带。 |
| x-version | String | 否 | 接口调用方的软件版本号。即当前客户端版本号,服务端可以基于其进行灰度,建议携带。 |
| x-caller-trace-id | String | 否 | 请求跟踪ID。用于串联服务调用方与服务端整体请求链条,建议携带。 |
Request Body
| 参数 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| collectorType | String | 是 | 数据采集器类型。可支持的取值如下:
|
| appInfo | AppInfo | 是 | 数据采集器的应用程序信息。请参见AppInfo数据模型。 |
| collectorDataType | DataType | 是 | 数据类型。请参见DataType数据模型。 |
| collectorId | String | 否 | 数据采集器唯一标识,该字段由请求中的参数根据规则生成。 |
| collectorName | String | 否 | 使用该名称来标识用户下同一类型数据产生的数据采集器,内部标识。 |
| name | String | 否 | 用户页面展示的数据采集器名称。 |
| deviceInfo | DeviceInfo | 否 | 集成各种传感器的硬件设备描述,例如:手表、手环等可穿戴设备。 请参见DeviceInfo数据模型。 |
POST
https://health-api.cloud.huawei.com/healthkit/v2/dataCollectors
Content-Type: application/json
Authorization: Bearer ***
x-client-id: ***
x-version: ***
x-caller-trace-id: ***
{
"collectorName": "DataCollectorExample",
"collectorType": "raw",
"appInfo": {
"appPackageName": "com.huawei.demo",
"appName": "Example App",
"desc": "https://huaweiapi.com",
"appVersion": "1"
},
"collectorDataType": {
"name": "com.huawei.continuous.steps.delta"
},
"deviceInfo": {
"manufacturer": "huawei",
"modelNum": "ExampleTablet",
"devType": "Phone",
"uniqueId": "1000",
"version": "1.0"
}
} 状态码为200时:
Response Header
| 参数 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Content-Type | String | 是 | 取值为:application/json; charset=UTF-8 |
Response Body
| 参数 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| collectorType | String | 是 | 数据采集器类型。可支持的取值如下:
|
| appInfo | AppInfo | 是 | 数据采集器的应用程序信息。请参见AppInfo数据模型。 |
| collectorDataType | DataType | 是 | 数据类型。请参见DataType数据模型。 |
| collectorId | String | 否 | 数据采集器唯一标识。该字段由请求中的参数根据规则生成。 |
| collectorName | String | 否 | 内部标识。使用该名称来标识用户下同一类型数据产生的数据采集器。 |
| name | String | 否 | 用户页面展示的数据采集器名称。 |
| deviceInfo | DeviceInfo | 否 | 集成各种传感器的硬件设备描述。例如:手表、手环等可穿戴设备。 请参见DeviceInfo数据模型。 |
HTTP/1.1 200 OK
Content-type: application/json;charset=utf-8
{
"collectorId": "cmF3OmNvbnRpbnVvdXMuc3RlcHMuZGVsdGE6EwMTI3ODUwMTpqEF7rB3uBcGykpv6T2TisfTMhfZAvz1BP2Kcz70d1Sg",
"collectorName": "DataCollectorExample",
"collectorType": "raw",
"collectorDataType": {
"name": "com.huawei.continuous.steps.delta",
"field": [
{
"name": "steps_delta",
"format": "integer"
}
]
},
"deviceInfo": {
"uniqueId": "1000",
"devType": "Phone",
"version": "1.0",
"modelNum": "ExampleTablet",
"manufacturer": "huawei"
},
"appInfo": {
"appName": "Example App",
"appPackageName": "com.huawei.demo",
"appVersion": "1",
"desc": "https://huaweiapi.com",
"clientId": "101222525"
}
}