主动调用接口(适用于两种模式)
除了回调的方式,华米开放平台还提供了主动调用接口以供第三方查询用户手环事件。目前该方式只是回调接口的补充,还没有明确的场景推荐使用该接口而不是回调接口。
认证
在注册为华米开放平台的第三方合作伙伴后,我们会发送独有的用户名密码给第三方合作伙伴。在主动调用华米开放平台的API接口需要调用端发送 Basic Authentication 头。
SDK 实例认证
第三方获得用户名密码后,在IOT SDK运行时,需先调用接口,向华米注册每个SDK的运行实例。为每个实例注册后,才能调用华米API接口,单独获取每个实例所扫描到的手环用户。
1. 增加第三方 SDK 实例
POST /thirdparty/-/hboxes
注:第三方可根据自身需要,自行任意分配所需的实例id (hbox id),只需要通过此接口向华米注册即可。同时第三方应自行维护实例id和用户的对应关系,方便日后获取数据时使用。
地址
https://api-beacon.huami-inc.com/thirdparties/-/hboxes
参数
Content-Type:application/json
Encoding: UTF-8
Http Header
Authorization: Basic OXB3Q1dmhpRQOVFFaXlXQWNSYTY6PFZnS2JRQldjSzNJdGFGREVSQ1hOd3g5dER4TXE2T0pTMjhxOVFUeUEzYkdPYjFqWlV6mJhbGNJedNds
Http Request
http request体为json的数组,数组的每一项为实例id (hbox id)
示例
POST https://api-beacon.huami-inc.com/thirdparties/-/hboxes
Content-Type: application/json
Encoding: UTF-8
Authorization: Basic OXB3Q1dmhpRQOVFFaXlXQWNSYTY6PFZnS2JRQldjSzNJdGFGREVSQ1hOd3g5dER4TXE2T0pTMjhxOVFUeUEzYkdPYjFqWlV6mJhbGNJedNds
[{“id”:"feffaa027a11"}, {“id”:"feffaa02bbcb"}, {“id”:"feffaa28588a"}]
2. 获取第三方的 SDK 实例列表
GET /thirdparty/-/hboxes/
地址
https://api-beacon.huami-inc.com/thirdparties/-/hboxes/
参数
无
示例
GET https://api-beacon.huami-inc.com/thirdparties/-/hboxes/
Content-Type: application/json
Encoding: UTF-8
Authorization: Basic OXB3Q1dmhpRQOVFFaXlXQWNSYTY6PFZnS2JRQldjSzNJdGFGREVSQ1hOd3g5dER4TXE2T0pTMjhxOVFUeUEzYkdPYjFqWlV6mJhbGNJedNds
[
{
"id":"34ab8b7c5dd8407681a22ff637507e43",
"applicationId":"10000323423",
"property":null,
"createdTime":1462952484
},
{
"id":"e6e892eddd7a4df1a3281765aa785583",
"applicationId":"10000323423",
"property":null,
"createdTime":1462952484
}
]
3. 删除第三方 SDK 实例
DELETE /thirdparty/-/hboxes
地址
https://api-beacon.huami-inc.com/thirdparties/-/hboxes
参数
Content-Type:application/json
Encoding: UTF-8
http request体为json的数组,数组的每一项为hbox的ID
示例
DELETE https://api-beacon.huami-inc.com/thirdparties/-/hboxes
Content-Type: application/json
Encoding: UTF-8
Authorization: Basic OXB3Q1dmhpRQOVFFaXlXQWNSYTY6PFZnS2JRQldjSzNJdGFGREVSQ1hOd3g5dER4TXE2T0pTMjhxOVFUeUEzYkdPYjFqWlV6mJhbGNJedNds
["feffaa027a11","feffaa02bbcb","feffaa28588a"]
4. 用户手环信号查询
查询用户的信号
Get /users/{huamiId}/signals
地址
GET https://api-beacon.huami-inc.com/thirdparties/-/hbox/{hboxId}/events
参数
参数名 | 含义 | 示例 | 备注 |
---|---|---|---|
hboxId | Hbox的标识 | 6351B8B07FAB4222B9C0261F9645CFD5 | 同时支持直传scanner的ID,例如feffaa27a11 |
From | 查询起始时间 | 1462952484 | Epoch秒 |
To | 查询终止时间 | 1463038884 | Epoch秒 |
last_evaluated_range_key | 上次查询返回的最后一条记录的标识 | 6351B8B07FAB4222B9C0261F9645CFD5_1468560388000_880f10ae2332 | |
Limit | 返回数量的限制 | 100 |
示例
GET https://api-beacon.huami-inc.com/thirdparties/-/hboxes/6351B8B07FAB4222B9C0261F9645CFD5/events?from=1468560741000&to=1468560742000
Content-Type: application/json
Encoding: UTF-8
Authorization: Basic OXB3Q1dmhpRQOVFFaXlXQWNSYTY6PFZnS2JRQldjSzNJdGFGREVSQ1hOd3g5dER4TXE2T0pTMjhxOVFUeUEzYkdPYjFqWlV6mJhbGNJedNds
{
result=
[
{
"openId":"1000000482",
"hboxId":"6351B8B07FAB4222B9C0261F9645CFD5",
"type":"swipe",
"scannerId": "ffae03dd3202"
"timestamp": 1456830820000
},
{
"openId":"1000000483",
"hboxId":"6351B8B07FAB4222B9C0261F9645CFD5",
"type":"swipe",
"scannerId": "ffae03dd3201"
"timestamp": 1456830819000
}
],
last_evaluated_range_key="6351B8B07FAB4222B9C0261F9645CFD5_1456830819000_1000000483"
}