健康数据 API
健康数据 API 是晓葆开放平台面向合作方的核心数据能力模块。 合作方可通过 S2S 接口将用户体系与晓葆平台打通,实现健康档案同步、 家庭组管理,并在授权后读取用户健康数据。
模块概述
健康数据 API 分为两类接入模式:
| 模式 | 典型场景 | 鉴权 |
|---|---|---|
| S2S 服务端对接 | 合作方将自身用户体系(用户、家庭组、家庭成员)与晓葆平台双向打通 | AppKey + MD5 签名 |
| OAuth2 授权读取 | 在用户明确授权后读取其健康指标数据(即将开放) | OAuth2 access_token |
核心能力
- 用户数据互通(Channel Users):将合作方用户、家庭组、家庭成员一次性写入晓葆平台, 实现健康档案、权益卡、AI 解读等能力与合作方用户体系的绑定。 详见 用户数据互通 API。
- 健康指标查询(即将开放):OAuth2 授权后读取用户血压、血糖、血氧、心率等 100+ 健康指标。
- 健康档案同步(即将开放):获取用户基础健康档案(身高、体重、血型、过敏史等)。
鉴权方式
S2S 接口使用 AppKey + MD5 签名鉴权,所有请求需携带以下 Header:
| Header | 类型 | 说明 |
|---|---|---|
X-App-Id | string | 控制台「凭证管理」中的 App ID |
X-Timestamp | integer | Unix 秒级时间戳,有效窗口 ±5 分钟 |
X-Signature | string | md5(api_key + timestamp + api_secret + request_body) |
完整签名算法见 鉴权说明。 AppSecret 必须仅在服务端使用,禁止写入客户端代码。
接口清单
当前已开放的 S2S 接口(前缀 /open/v1/):
| 方法 | 路径 | 说明 |
|---|---|---|
| POST | /open/v1/channel/users | 注册绑定用户 + 家庭组 + 成员(幂等) |
| GET | /open/v1/channel/users/{openUserId} | 全量用户快照 |
| PATCH | /open/v1/channel/users/{openUserId} | 更新用户基础信息 |
| POST | /open/v1/channel/users/{openUserId}/family-groups | 新增或更新家庭组 |
| DELETE | /open/v1/channel/users/{openUserId}/family-groups/{groupId} | 解散家庭组 |
| POST | /open/v1/channel/users/{openUserId}/family-members | 新增或更新家庭成员 |
| DELETE | /open/v1/channel/users/{openUserId}/family-members/{memberId} | 删除家庭成员 |