健康证管理平台广东食品药品监督管理局

发布时间:   来源:文档文库   
字号:

广东省食品从业人员健康检查管理平台
接口规范文档







2017-11




改版记录
版本1.0

发布日期2017/11/24

建立该文档,初稿

描述
作者
复审
批准

变更记录
变更编号

日期

变更项描述


基线版本

变更请求编号



目录
123
概述...........................................................................................误!未指定书签。适用范围...................................................................................误!未指定书签。接口概述...................................................................................误!未指定书签。3.13.23.3
接口概述.......................................................................误!未指定书签。数据类型与格式...........................................................误!未指定书签。接口参数格式...............................................................误!未指定书签。3.3.13.3.23.44
请求参数...........................................................误!未指定书签。响应参数...........................................................误!未指定书签。
接口访问地址...............................................................误!未指定书签。
接口逻辑结构设计...................................................................误!未指定书签。4.14.2
微信预约平台接口架构...............................................误!未指定书签。体检业务监控接口架构...............................................误!未指定书签。
5接口详细参数和格式...............................................................误!未指定书签。5.1
数据签名验证...............................................................误!未指定书签。5.1.15.2
数字签名生成功能接口...................................误!未指定书签。
微信端接口...................................................................误!未指定书签。5.2.1
体检机构信息接口...........................................误!未指定书签。
5.3体检系统接口...............................................................误!未指定书签。5.3.15.3.25.3.35.3.45.3.5
体检登记...........................................................误!未指定书签。体检结果体检明细接口...................................误!未指定书签。健康证打印接口...............................................误!未指定书签。短信通知上传接口...........................................误!未指定书签。验血人脸比对分析...........................................误!未指定书签。
6附录:字典...............................................................................误!未指定书签。6.1
接口功能编号...............................................................误!未指定书签。
广东省食品从业人员健康检查管理平台

接口规范文档

1概述
健康证管理平台按照省局关于体检机构现场巡查和体检业务实时监控的要求制定。目的是实时获取体检机构的实时业务监控数据,保证服务业从业人员的体检信息的真实性。
主要实时监控如下:
体检机构体检系统和省平台实时上传数据
1体检登记2抽血登记3体检结果4体检打印5短信通知
身份证相片人脸核验相片省平台业务串
人脸核验相片省平台业务串
体检结果检验明细
打印记录体检结果二维码
短信通知短信通知明细

健康证管理平台提供接口应用服务,供各接入系统访问调用。在调用时,需按照本文档规定格式拼装参数,传入参数调用平台端接口,接收接口获取返回信息。各接入系统将返回信息进行解析后供自身系统处理使用
2适用范围
本文档主要用于描述接口的定义、调用说明。文档可供接入健康证管理平台的各系统建设方、开发方阅读及使用。
3接口概述
3.1接口概述
健康证管理平台作为服务端,以方式为各个第三方系统等提供接口服务。接口采用协议,请求方在请求时以64加密入参,服务器解密处理,返回64加密回参,请求端自行解密使用。
接口统一入口方法为,通过参数进行业务区分。
3.2数据类型与格式

如无特殊说明,本文档中的部分数据均为以下格式:
日期:,即4位年,2位月份,2位日期。数据类型记为,长度为10时间::,即2位小时(24小时制),2为分钟,2为秒。数据类型记为,长度为6.
日期时间::。数据类型记为,长度为19.
带毫秒日期时间::::。为毫秒数。数据类型记为,长度为17金额:,整数部分最多为8位,小数点1位,小数部分为2位,若小数部分为0,则小数点和小数部分可以省略。计量单位为人民币元。数据类型记为,最大长度为11
单价:,,整数部分最多为8位,小数点1位,小数部分最多为2位,若小数部分为0,则小数点和小数部分可以省略。计量单位为人民币元。数据类型记为,最大长度为11
数量:8位整数,2为小数。小数部分为0小数点和小数部分可以省略,最大长度11位。数据类型记为。其他数据请参照数据字典。
3.3接口参数格式
3.3.1请求参数
请求参数为标准字符串,顶层节点名称为,其下节点包括头部及数据两部分,具体格式如下:
<>

<>
<>应用<><><>
<>请求方法<><>接口方法版本<><>参数签名<><>请求时间<><>流水号<>



<><>


<>
<>
标签名
数据类


请求应用的会话或者请求的方法接口版本参数签名请求时间戳流水号

接入方应用分配的应用

中文名称必填项说明
3.3.2响应参数
响应参数为标准字符串,顶层节点名称为,其下节点包括头部节点及响应数据两部分,具体格式如下:<>

<>
<>结果值编码<><>结果描述<><>结果详细描述<><><>

<><>


<>

<>
标签名

数据类型中文名称
结果值编码结果消息结果详细描述响应时间
必填项
说明
见字典(提示信息)见字典(提示信息)
结果详细描述,错误时可以提供格式::
备注
当响应参数包括多个子项时,子项内容父节点为,各子项内容节点为。

<>
<>头部公共响应参数<><><><><><><><>




<>...
<>
<>
<>
3.4接口访问地址




4接口逻辑结构设计
4.1微信预约平台接口架构
互联网
体检机构接口
机构调用数据上传
机构信息接口
机构调用数据上传
体检预约排班接口
机构调用数据上传机构轮询调用数据上传
体检预约
机构身份认证接口消息通知接口
体检机构
微信公众号接口
微信公众号平台
机构信息接口体检预约排班接口机构身份认证接口消息通知接口
微信公众号接口管理
体检机构业务系统
接口用户管理
省健康证管理平台
接口调用日志接口申请审核接口服务统计查询

4.2体检业务监控接口架构
互联网
体检机构接口
机构调用数据上传
实时业务验证串
机构调用数据上传
人脸核验数据接口
机构调用数据上传
体检结果和明细接口
机构调用数据上传
体检表打印接口
机构轮询调用数据上传
消息通知接口
体检业务实时监控接口
实时业务验证串身份证、人脸核验数据
接口体检结果和明细接口
省健康证管理平台
体检表打印信息接口
消息通知接口
体检机构登记功能
体检机构业务系统
身份读卡器登记人脸识别系统登记生化仪设备登记酶标仪设备登记接口申请审核查询统计分析


5接口详细参数和格式
5.1数据签名验证
5.1.1数字签名生成功能接口
接口方法请求方法()接口描述接口协议加密算法

900100(见接口功能编号字典)数字签名生成接口5
5.1.1.1
<>
请求消息
<>头部公共请求参数<><>
<><>
<><>
<><>
<><>
<><><>
<>
标签名
必填
类型
说明
接口业务类型(见接口功能编号字典)机构编码用户名
用户接口密码,加密:5
系统对接前,分配给机构的,相当于身份唯一识别码
5.1.1.2返回消息

<>
<>头部公共响应参数<><><><><>
<>
标签名

类型
说明
数字签名,该签名用于业务接口调用的认证码生成,数字签名具有时效性

5.2微信端接口
5.2.1体检机构信息接口
接口方法请求方法()接口描述接口协议加密算法

C00100(见接口功能编号字典)体检登记接口564
5.2.1.1
<>
请求信息
<>头部公共请求参数<><>


<><><><><><><><><><>

<><>
<><>
标签名

是否必填

类型说明
接口业务类型(见接口功能编号字典)机构编码
接口验证认证码,用于和服务器验证接口访问的合法性,该认证码依据数字签名以及参数值排序相应规则生成



机构简称机构名称地址
5.2.1.2
<>
返回消息
<>头部公共响应参数<><>
<><><><><><><><><><><><><><><><><><><><><><><><>

<><><><><><><><><><><><><><><><><><><><><><>
<><>
标签名

类型
接口调用结果:接口返回消息业务机构唯一码
机构编码机构名称机构简称图标医疗机构代码所在地区地址负责人联系电话纬度经度监管状态:0-非监管,1-监管
说明



启用时间推荐级别E工作时间说明评价分数:0~5评价总分评级次数
5.3体检系统接口
5.3.1体检登记
接口方法请求方法()接口描述接口协议加密算法

C00100(见接口功能编号字典)体检登记接口564
5.3.1.1
<>
请求信息
<>头部公共请求参数<><>


<><><><><><><><><><><><><><><><>

<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
<><>
标签名

是否必填

类型
说明
接口业务类型(见接口功能编号字典)机构编码
接口验证认证码,用于和服务器验证接口访问的合法性,该认证码依据数字签名以及参数值排序相应规则生成



体检机构体检点体检车辆编码前缀


二者选一

预约单订购类型:1-个人,2-团体,3-临时加号姓名身份证号码性别年龄民族身份证头像64身份证无法识别脸情况,身份证拍照64登记面部64联系电话微信号行业类别大类:1:食品行业类别小类文化程度预约时间登记时间登记号码,号码格式:{1}B{3}(C{2}?其中A为地点编号,B为序列号,C为复检编号,如果复检,尾号则加-1-2等复检编号



5.3.1.2
<>
返回消息
<>头部公共响应参数<><>
<><><><><><>

<><>
<><>
标签名

类型
接口调用结果:接口返回消息体检登记唯一码
说明
5.3.2体检结果体检明细接口
接口方法请求方法()接口描述接口协议加密算法

C00200(见接口功能编号字典)体检登记接口564
5.3.2.1
<>
请求信息
<>头部公共请求参数<><>


<><><><><><><><><><><><><><><><><><><><>

<><><><><><><><><><><><><><><>
<>
<><><><><><><1><1><2><2><3><3><4><4><><>
<>
<><>
标签名

是否必填

类型
说明
接口业务类型(见接口功能编号字典)机构编码
接口验证认证码,用于和服务器验证接口访问的合法性,该认证码依据数字签名以及参数值排序相应规则生成



健康证信息体检类别:0-初检,1-复检
<>




体检项目大类体检时间体检操作人结果:合格、不合格、未出结果结果时间结果录入人结果有效性,有效,无效,当复检结果录入时,把初检的结果设置为无效。
明细1234


体检时间结论时间检查结论:合格,未合格检查结论说明结论医师


体检项目信息体检项目小类项目结果,合格,不合格,可疑
预留字段预留字段预留字段预留字段项目结果描述
5.3.2.2
<>
返回消息
<>头部公共响应参数<><>
<><>

<><><>><><>
<><>
标签名

类型
接口调用结果:接口返回消息体检主表唯一
说明
5.3.3健康证打印接口
接口方法请求方法()接口描述接口协议加密算法

C00300(见接口功能编号字典)体检登记接口564
5.3.3.1
<>
请求信息
<>头部公共请求参数<><>
<><>


<><><><><><><><><><><><><><>

<><><><>
<><>
标签名

是否必填

类型
说明
接口业务类型(见接口功能编号字典)机构编码
接口验证认证码,用于和服务器验证接口访问的合法性,该认证码依据数字签名以及参数值排序相应规则生成



健康证打印操作人打印时间健康证姓名所属团队健康证联系方式行业小类
5.3.3.2
<>
返回消息
<>头部公共响应参数<><>
<><><><><><>
<><>
标签名
类型
说明



接口调用结果:接口返回消息打印记录
5.3.4短信通知上传接口
接口方法请求方法()接口描述接口协议加密算法

C00400(见接口功能编号字典)体检登记接口564
5.3.4.1
<>
请求信息
<>头部公共请求参数<><>
<><>


<><><><><><><><><><>
<><>
标签名

是否必填

类型
说明
接口业务类型(见接口功能编号字典)机构编码
接口验证认证码,用于和服务器验证接口访问的合法性,该认证码依据数字签名以及参数值

排序相应规则生成



手机号码发送内容发送时间
5.3.4.2
<>
返回消息
<>头部公共响应参数<><>
<><><><><><><><>
<><>
标签名

类型
接口调用结果:接口返回消息短信唯一码
状态:0-待发送,1-已发送,2-发送失败
说明
5.3.5验血人脸比对分析
接口方法请求方法()接口描述接口协议加密算法

C00700(见接口功能编号字典)验血人脸比对分析接口564
5.3.5.1请求信息

<>
<>头部公共请求参数<><>
<><>


<><><><><><><><><><>
<><>
标签名

是否必填

类型
说明
接口业务类型(见接口功能编号字典)机构编码
接口验证认证码,用于和服务器验证接口访问的合法性,该认证码依据数字签名以及参数值排序相应规则生成



姓名身份证号码身份证头像64登记头像64采血登记面部64
5.3.5.2
<>
返回消息
<>头部公共响应参数<><>
<><><><>

<><><><>
<><>
标签名

类型
接口调用结果:接口返回消息比对结果唯一码比对结果比对相似度
说明
6附录:字典
6.1接口功能编号
简要描述:
功能编码说明功能编码900100C00100C00300C00400C00500C00600C00700
功能名称
数字签名生成功能接口体检机构信息接口体检登记接口体检结果体检明细接口健康证打印接口短信通知上传接口验血人脸比对分析接口

本文来源:https://www.2haoxitong.net/k/doc/4d47b89ad2d233d4b14e852458fb770bf78a3bb4.html

《健康证管理平台广东食品药品监督管理局.doc》
将本文的Word文档下载到电脑,方便收藏和打印
推荐度:
点击下载文档

文档为doc格式