# 健康状态接口
# 接口描述
开发者提供获取用户健康状态接口,电子码将展示健康状态的样式及文案,实现原来健康码与电子码的融合。
# 申请方式
发送邮件到zhimuli@tencent.com进行申请(邮件同时也抄送至hongfuhuang@tencent.com,ronniewan@tencent.com,marshalyang@tencent.com),申请时需要注明接口地址以及鉴权使用的APPKEY
#
# 请求方法
POST(application/json)
# 请求地址
开发者提供
# 参数说明
{
"app_key": "APP_KEY",
"timestamp": "TIMESTAMP",
"nonce": "NONCE",
"signature": "SINGATURE",
"ocode": "SCHOOL_CODE",
"card_number": "LOCATION"
}
参数 | 必填 | 类型 | 实例 | 说明 |
---|---|---|---|---|
app_key | 是 | String | xxx | 微卡分配APP_KEY |
card_number | 是 | String | 123456 | 电子卡号 |
ocode | 是 | String | 1402513210 | 主体编码 |
timestamp | 是 | Long | 1514276659 | 时间戳 |
nonce | 是 | String | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 32位随机字符串 |
signature | 是 | String | A790E009D30C09BD8605810EAF9C44B0 | 签名 |
签名方式:见签名算法。
# 响应说明
{
"errcode": 0,
"errmsg": "ok",
"status": 1,
"title": "已完成健康申报",
"desc": "更新于: 2022-10-01 10:00",
"detail": "您于前14天内到达或途经:广东省深圳市*(注:*表示当前该城市存在中风险或高风险地区,并不表示用户实际到访过这些中高风险地区。)",
"hsjg": {
"jcrq": "2022-04-12 12:10",
"jcjgmc": "",
"jcjg": ""
},
"ymxx": [
{
"ymmc": "新冠疫苗(Vero细胞)",
"jzjc": 1,
"jzrq": "2021-03-01",
"scqy": "北京科兴",
"jzdq": "深圳市"
},
{
"ymmc": "新冠疫苗(Vero细胞)",
"jzjc": 2,
"jzrq": "2021-05-01",
"scqy": "北京科兴",
"jzdq": "深圳市"
},
{
"ymmc": "新冠疫苗(Vero细胞)",
"jzjc": 3,
"jzrq": "2022-03-01",
"scqy": "北京科兴",
"jzdq": "深圳市"
}
]
}
参数 | 必填 | 类型 | 实例 | 说明 | |
---|---|---|---|---|---|
errcode | 是 | Integer | 0 | 状态码,0为成功,非0为错误 | |
errmsg | 是 | String | success | 状态描述信息 | |
status | 是 | Int | 1 | 健康状态:0-未知;1-正常(绿码);2-红码异常(红码);3-黄码异常(黄码) | |
title | 是 | String | 已完成健康申报 | 健康状态标题 | |
desc | 否 | String | 更新于: 2022-10-01 10:00 | 健康状态描述 | |
detail | 否 | String | 您于前14天内到达或途经:广东省深圳市*(注:*表示当前该城市存在中风险或高风险地区,并不表示用户实际到访过这些中高风险地区。) | 健康状态详情 | |
hsjg | jcrq | 否 | String | 2022-10-01 10:00 | 检测日期 |
jcjgmc | 否 | String | 深圳罗湖医院 | 检测机构名称 | |
jcjg | 否 | String | 阴性 | 检测结果 | |
ymxx | ymmc | 否 | String | 新冠疫苗(Vero细胞) | 疫苗名称 |
jzjc | 否 | Integer | 1 | 接种剂次 | |
jzrq | 否 | String | 2022-01-23 | 接种日期 | |
scqy | 否 | String | 北京科兴 | 生产企业 | |
jzdq | 否 | String | 深圳市 | 接种地区 |