认证
在注册为华米开放平台的第三方合作伙伴后,我们会发送独有的用户名密码给第三方合作伙伴。在主动调用注册用户的API接口时,需要调用端发送 Basic Authentication 头。
注册用户 (适用于To C模式,手环已绑定App)
此接口仅适用于第三方的用户已经绑定了小米运动的情况 (To C 模式)
若第三方自主购买手环,并发放给用户,请使用本页的“注册手环”接口
在得到用户授权后,使用华米账号系统颁发的app_token,可以在系统中注册该用户,之后便可以查询该用户的相关事件,或者华米开放平台会主动将时间实时的发送到注册的回调地址中。
1. 注册用户接口
只有在主动向开放平台注册用户之后,该用户上传的事件才会被处理,对应的事件才会发送到第三方的回调地址。
地址
POST https://api-beacon.huami-inc.com/users/-/bindThirdParty
http头
为了认证用户的授权,需要在调用该API时在http头附带从账号系统得到的token以及注册时的三方名
X-AppName:第三方的注册Id, 例如com.huami
X-AppToken : 从华米账号系统返回的app_token,例如TAQABAAAAAOTth6VLHHwGP3MP6z27RfZ_nZeI2gj3i-7gYftza81DQ4wRGu7HAvBAMmRaZmu5Ra0TFgF2x0hlgETTtvAZTPH95yqCUengwhYo_j6AIj_x8hjWLf7q6D8i9EURe7DroFFdM6gD_jjr-cOmsWK-34Oub8elVb6M3PLU2s61fX3OjyqeD_x1ij18evGCaXnYu6IMGGYifCVGB8fHpeqJCN3x6J2ECzB0eCyuiXGpgZln
请求消息体
Content-Type:application/json
Encoding: UTF-8
{
"applicationId":"mi-hbeacon-attendance" /*华米分配的thirdpartyId, 注意,不是账号系统返回的third_id*/
}
示例
POST https://api-beacon.huami-inc.com/users/-/bindThirdParty
{
"applicationId":"7"
}
注册手环(适用于To B模式,手环未绑定App)
此接口仅适用于第三方自主购买手环,并发放给用户
第三方的用户已经绑定了小米运动的情况 (To C 模式),请使用本页的“注册用户”接口
1. 增加三方注册手环
POST /thirdparties/-/offlines
地址
https://api-beacon.huami-inc.com/thirdparties/-/offlines
参数
Content-Type:application/json
Encoding: UTF-8
Http Header
Authorization: Basic OXB3Q1dmhpRQOVFFaXlXQWNSYTY6PFZnS2JRQldjSzNJdGFGREVSQ1hOd3g5dER4TXE2T0pTMjhxOVFUeUEzYkdPYjFqWlV6mJhbGNJedNds
http request体为json的对象,表示手环的注册信息
参数名 | 含义 | 是否必须 | 示例 备注 |
---|---|---|---|
userId | 手环的mac地址 | 是 | c80f10665eb4,请注意要使用小写字母以及不使用冒号(:)分割mac地址 |
applicationId | 华米开放平台第三方的表示 | 是 | com.huami.hbeacon,会在注册第三方时告知 |
deviceType | 手环的种类 | 否 | |
deviceSource | 手环的小类 | 否 |
示例
POST https://api-beacon.huami-inc.com/thirdparties/-/offlines
Content-Type: application/json
Encoding: UTF-8
Authorization: Basic OXB3Q1dmhpRQOVFFaXlXQWNSYTY6PFZnS2JRQldjSzNJdGFGREVSQ1hOd3g5dER4TXE2T0pTMjhxOVFUeUEzYkdPYjFqWlV6mJhbGNJedNds
application/json; charset=utf-8
{
"userId":"c80f10665eb4",
"applicationId":"com.huami.hbeacon",
"deviceType":0,
"deviceSource":0
}
2. 删除三方注册手环
DELETE /thirdparties/-/offlines
地址
https://api-beacon.huami-inc.com/thirdparties/-/offlines
参数
Content-Type:application/json
Encoding: UTF-8
http request体为json的对象,表示手环的注册信息
参数名 | 含义 | 是否必须 | 示例 |
---|---|---|---|
userId | 手环的mac地址 | 是 | c80f10665eb4 |
applicationId | 华米开放平台第三方的表示 | 是 | com.huami.hbeacon |
示例
DELETE https://api-beacon.huami-inc.com/thirdparties/-/offlines
{
"userId":"c80f10665eb4",
"applicationId":"com.huami.hbeacon"
}