血压月报服务是一项基于血压数据的月报服务,通过对用户提供的血压数据分析,生成详细的血压报告,帮助用户了解自身血压状况并提供相应的健康建议。
血压月报分为两个接口:
生成血压月报:通过最近30天的血压测量数据生成血压报告,返回血压报告访问链接。
获取报告列表:查询指定用户下已生成的血压月报列表。
当用户希望查看最近一个月的血压状况时,您可以使用生成血压月报接口生成用户的指定时间段的血压月报。
当用户希望查看历史血压月报时,您可以使用获取报告列表接口获取当前用户下历史月报列表并展示给用户。
HOST: https://sdkb.omronhealthcare.com.cn/api
Version: v1
接口地址:/{version}/Api/GenerateReport
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述: 通过最近30天的血压数据生成血压报告。
请求示例:
xxxxxxxxxx【host】/v1/Api/GenerateReport
headers:{ "appKey": "", "secret": ""}
body:{ "bpList": [ { "sbp": 123, "dbp": 86, "pulse": 80, "measureAt": "2023-02-11 11:10:20", "type": 0 } ], "uuid": "【用户的唯一标识】"}请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| appKey | appKey | header | true | ||
| secret | 1、截取AppKey前九位 2、截取后的AppKey加盐(密钥) 3、使用MD5生成secret eg、md5Util.EncoderByMd5(appKey.substring(0, 9) + salt) | header | true | ||
| version | 版本号 | path | true | string | |
| bpList | 血压列表 | true | array | ||
| sbp | 高压 | true | integer | ||
| dbp | 低压 | true | integer | ||
| pulse | 脉搏 | true | integer | ||
| type | 数据来源 0:家庭 1:诊室 | true | integer | ||
| measureAt | 测量时间( pattern = "yyyy-MM-dd HH:mm:ss") | true | string | ||
| uuid | 用户唯一标识 | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 300 | 用户唯一标识不能为空 | |
| 404 | 未找到资源 | |
| 512 | 血压报告服务未开通 | |
| 513 | 血压报告服务已过期 | |
| -120024 | AppKey Secret 验证失败 |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int64) | integer(int64) | |
| data | WebPathVo | WebPathVo | |
| createAt | 创建时间 | string | |
| path | 报告访问路径 | string | |
| message | string |
响应示例:
xxxxxxxxxx{ "code": 0, "message": "", "data": { "createAt": "", "path": "" } }接口地址:/{version}/Api/BpReportUrl
请求方式:GET
响应数据类型:*/*
接口描述: 通过用户的唯一标识查询已生成的报告列表。
请求示例:
xxxxxxxxxx【host】/v1/Api/BpReportUrl?uuid=【用户uuid】
headers:{ "appKey": "", "secret": ""}
请求参数:
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| appKey | appKey | header | true | ||
| secret | 1、截取AppKey前九位 2、截取后的AppKey加盐(密钥) 3、使用MD5生成secret eg、md5Util.EncoderByMd5(appKey.substring(0, 9) + salt) | header | true | ||
| uuid | 用户唯一标识 | query | true | string | |
| version | 版本号 | path | true | string |
响应状态:
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | OK | |
| 300 | 用户唯一标识不能为空 | |
| 404 | 未找到资源 | |
| 512 | 血压报告服务未开通 | |
| 513 | 血压报告服务已过期 | |
| -120024 | AppKey Secret 验证失败 |
响应参数:
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | integer(int64) | integer(int64) | |
| data | array | ||
| createAt | 创建时间 | string | |
| path | 报告访问路径 | string | |
| message | string |
响应示例:
xxxxxxxxxx{ "code": 0, "message": "" "data": [ { "createAt": "", "path": "" } ] }