体脂秤开放能力

更新时间:2021-04-22 10:20:19下载pdf

本文介绍体脂秤相关接口。

API 列表

请求方式 API 描述
POST /v1.0/scales/{device_id}/analysis-reports 生成体脂报告
GET /v1.0/scales/{device_id}/datas/history 获取体脂秤称重记录
PUT /v1.0/scales/{device_id}/users/{user_id}/datas/{id} 绑定体脂秤称重记录
DELETE /v1.0/scales/{device_id}/datas/{id} 删除体脂秤称重记录
DELETE /v1.0/scales/{device_id}/users/{user_id}/datas 删除用户的称重记录
GET /v1.0/scales/{device_id}/users/{user_id}/trend-datas 获取用户趋势数据

生成体脂报告

功能描述

生成体脂报告。

接口地址

POST /v1.0/scales/{device_id}/analysis-reports

请求参数

参数名 类型 参数类型 说明 必填
device_id String URI 设备 ID
height Double Boby 身高(cm)
weight Double Boby 体重(kg)
age Integer Boby 年龄
sex Integer Boby 性别:
  • 1:男
  • 2:女
resistance String Boby 体脂秤电阻

返回参数

参数名 类型 说明
code Integer 详情参见错误码
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功为空。
result Object 体脂报告信息。

Result

参数名 类型 说明
Boby_type Integer 身型类型:
  • 0:过轻
  • 1:正常
  • 2:过重
  • 3:肥胖
  • 4:非常肥胖
weight Double 体重
ffm String 去脂体重
water String 水分
Boby_score String 身型得分
bones String 骨量
muscle String 肌肉量
protein String 蛋白质
fat String 体脂
metabolism String 基础代谢
visceral_fat String 内脏脂肪等级
Boby_age String 身体年龄
bmi String BMI

请求示例

POST /v1.0/scales/xxx/analysis-reports { "height":178, "weight":78.3, "resistance":718, "age":26, "sex":1 }

返回示例

{ "success": true, "t": 1540955256215, "result": { "Boby_type":2, "weight":78.3, "ffm":"58.3", "water":"51.4", "Boby_score":"82.1", "bones":"3.6", "muscle":"54.9", "protein":"18.5", "fat":"25.5", "Boby_age":"29", "metabolism":"1778", "visceral_fat":"9.3", "bmi":"27.1" } }

获取体脂秤称重记录

功能描述

获取体脂秤称重记录。

接口地址

GET /v1.0/scales/{device_id}/datas/history

请求参数

参数名 类型 参数类型 说明 必填
device_id String URI 设备 ID
page_no Integer URL 分页数,1 为第一页。
page_size Integer URL 每页的行数
user_id String URL 用户 ID
start_time Long URL 开始时间的 13 位时间戳
end_time Long URL 结束时间的 13 位时间戳

返回参数

参数名 类型 说明
code Integer 详情参见错误码
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功为空。
result Object 体脂秤称重记录。

Result

参数名 参数类型 说明
total Integer 分页总数
records List 每条称重记录

Records

参数名 参数类型 说明
device_id String 设备 ID
id String 数据 ID
user_id String 关联的用户 ID
nick_name String 关联用户的名称
create_time Long 创建时间
weight Double 体重(kg)
height Double 身高(cm)

请求示例

GET /v1.0/scales/48264660bcddc215e183/datas/history?page_no=1&page_size=10

返回示例

{ "success":true, "t":1573441137, "result":{ "total":2, "records":[ { "device_id":"xxx", "id":"0020y", "user_id":"00234", "nick_name":"yangyc", "create_time":1573441137 }, { "device_id":"xxx", "id":"0020z", "user_id":"00233", "nick_name":"yangyc2", "create_time":1573441137 } ] } }

绑定称重数据

功能描述

将体脂秤称重数据和用户绑定。

接口地址

PUT /v1.0/scales/{device_id}/users/{user_id}/datas/{id}

请求参数

参数名 类型 参数类型 说明 必填
device_id String URI 设备 ID
user_id String URI 用户 ID
id String URI 数据 ID

返回参数

参数名 类型 说明
code Integer 详情参见错误码
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功为空。
result Boolean 是否绑定成功。

请求示例

POST /v1.0/scales/ve1231023o120/users/97/datas/xxxx0001

返回示例

{ "success":true, "t":1573441137, "result":true }

删除体脂秤称重记录

功能描述

删除体脂秤称重记录。

接口地址

DELETE /v1.0/scales/{device_id}/datas/{id}

请求参数

参数名 类型 参数类型 说明 必填
device_id String URI 设备 ID
id String URI 数据 ID

返回参数

参数名 类型 说明
code Integer 详情参见错误码
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功为空。
result Boolean 返回的结果。

请求示例

DELETE /v1.0/scales/ve12023131/datas/1

返回示例

{ "success":true, "t":1573441137, "result":true }

删除用户的称重记录

功能描述

删除用户的称重记录。

接口地址

DELETE /v1.0/scales/{device_id}/users/{user_id}/datas

请求参数

参数名 类型 参数类型 说明 必填
device_id String URI 设备 ID
user_id String URI 用户 ID

返回参数

参数名 类型 说明
code Integer 详情参见错误码
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功为空。
result Boolean 请求结果。

请求示例

DELETE /v1.0/scales/ve123891293/users/97/datas

返回示例

{ "success":true, "t":1573441137, "result":true }

获取用户趋势数据

功能描述

获取用户趋势数据,默认显示当前周。

接口地址

GET /v1.0/scales/{device_id}/users/{user_id}/trend-datas

请求参数

参数名 类型 参数类型 说明 必填
device_id String URI 设备 ID。
user_id String URI 绑定的用户 ID。
start_day String URL 开始时间,格式为"yyyyMMdd"
end_day String URL 结束时间,格式为"yyyyMMdd"

返回参数

参数名 类型 说明
code Integer 详情参见错误码
success Boolean 是否成功:
  • true:成功
  • false:失败
msg String 请求失败的信息,成功为空。
result Array 趋势列表。

Result

参数名 参数类型 说明
day String 记录时间,以天为单位。
value String 称重记录,每天最新的一次称重记录。

请求示例

GET /v1.0/scales/ve1231231/users/1/trend-datas?start_day=20190802&end_day=20191103

返回示例

{ "success":true, "t":1573441137, "result":[{ "value":"50.0", "day":"20190102" },{ "value":"51.0", "day":"20190103" }] }