# 口罩预约H5接入

# 1.背景介绍

该文档为腾讯健康小程序接入口罩预约标准文档。

合作方以 H5 跳转方式接入到小程序中来，按照标准文档的流程和接口接入。

大体的流程时序可以参考下图

# 2.接入信息

合作方接入包括两方面：1、基础信息提供；2、请求接口

# 2.1 基础信息提供

主要包括以下数据，该部分数据通过邮件方式发送给腾讯健康侧。

# 1. 合作方名称：希望展示的统一名称

# 2. 口罩预约模式：抢购/抽签

# 3. 开放省份城市列表：开放口罩预约的省份城市对应表

# 4. 预约步骤：用户进入H5页面后到领取口罩的流程指示，最多 5 步，每一步需要有主标题（12字以内）+ 副标题（20字以内）示例如下

口罩步骤图

# 5. 规则说明：文本内容，预约规则，不超过1000字。示例如下

规则说明图

# 6. 跳转合作方 H5 界面 url

从中间页跳转合作方主要有两个页面：预约主页、预约记录页，两者的 url 格式相同：合作方界面 url + 腾讯健康传入参数

跳转示例：https://www.qq.com?citycode=xxx&token=xxx

（1）合作方界面url：由合作方确定

（2）腾讯健康传入参数：在跳转时由腾讯健康传入，参数定义为：

序号	字段	名称	备注
1	citycode	城市码	预约城市的行政区划代码，详见最新县及县以上行政区划代码 (opens new window)
2	token	腾讯健康token	合作方以token来请求腾讯侧接口，获取用户手机号、用户的腾讯健康openid等信息

# 综上，针对跳转url，合作方需提供的信息为：`预约界面url`、`预约记录url`

合作方在以上数据准备完成后，可以邮件方式发送给腾讯健康侧，即可开始对接。

# 2.2 请求接口

以下接口为合作方请求腾讯侧，进行必需数据获取和预约数据同步

网关接入请看网关接入标准

网关接入文档中的 $app 直接用 reservation替代即可

# 1. 获取用户信息

合作方需要通过跳转url获取的token主动向腾讯侧获取用户信息，以此做后续的预约和数据同步等

接口名： getUserInfo

请求参数：

序号	字段	名称	类型	必填	备注
1	token	腾讯健康token	string	✔️	腾讯健康token，在请求url中传入合作方

返回参数：

序号	字段	名称	类型	必填	备注
1	code	返回码	int	✔️	0：正常，其他：异常。
2	message	状态描述	string	✔️
3	userInfo	用户数据详情	userInfo	✔️

# userInfo

序号	字段	名称	类型	必填
1	openId	腾讯健康小程序openId	string	✔️
2	phone	用户手机号	string	✔️
3	latitude	用户位置纬度	double	✖️
4	longitude	用户位置经度	double	✖️

# 2. 同步预约结果

主要是在用户预约的口罩成功或失败时，需要通知，对腾讯健康侧进行同步

通知时机

（1）预约成功（抢购模式）/中签（抽签模式）；（2）预约失败（抢购模式）/未中签（抽签模式）；（3）预约到货（抢购模式）

接口名： notifyMaskStatus