健康证管理平台-广东食品药品监督管理局.docx
广东省食品从业人员健康检查管理平台接口规范文档2017-11改版记录JK*发布日期描述作者复审批准1.02017/11/24建立该文档,初稿变更记录交更一号日期描述基线版本变更求号书目1 概述42 适用越阳.43 接口概述43.1 接口概述.43.2 数据类型与格式53.3 接口参数格式5恳求参数5响应参数63.4 接口访问地址84 接口逻辑结构设计84.1 微信预约平台接口架构84.2 体检业务监控接口架构85 接口具体参数和格式95.1 数据签名验SE9数字签名生胜利能接口95.2 微信端接口10体检机构信息接口105.3 体检系统接口13体检登记13体检结果体检明细接口16健康证打印接口19短信通知上传接口21脸血人比对分析236 附录：字典256.1 接口功能编号25广东省食品从业人员健康检查管理平台接口规范文档1概述健康证管理平台根据省局关于体检机构现场巡查和体检业务实时监控的要求制定。目的是实时获得体检机构的实时业务监控数据，保证服务业从业人员的体检信息的真实性。主要实时监控如下：WQ机构的Q嶷线和筋丁仃4纣忧(tfH)(twa)()(ti>)(u)<<!O)(fffft)(m)检站m%吟(tf¾)健康证管理平台供应Wcbscrvice接口应用服务，供各接入系统访问调用.在调用时，需根据本文档规定格式拼装参数，传入参数调用平台端WebSerViCe接口，接收WebSerViCe接口获得返回信息。各接入系统将返回信息进行解析后供自身系统处理运用.2适用范围本文档主要用于描述MbSeryiCe接口的定义、调用说明。文档可供接入健康证管理平台的各系统建设方、开发方阅读及运用。3接口概述3.1 接口概述健康证管理平台作为服务端，以WebSerViCe方式为各个第三方系统等供应接口服务.接口采纳SOAP协议，恳求方在恳求时以bas064加密入参，服务器解密处理，返回bse64加密回参，恳求端自行解密运用。WebSerViCe接口统一入口方法为CanFUn,通过method参数进行业务区分。3.2 数据类型与格式如无特别说明，木文档中的部分数据均为以下格式： H期：YYYY-MM-DD.即4位年，2位月份.2位日期.数据类型记为DATE,长度为10. 时间：HH：MM:SS.即2位小时（24小时制.2为分钟,2为佻数据类型记为TIME.长度为6. 口期时间:YYYY-MM-DDHH：MMSS.数据类型记为DATETIME,长度为19. 帝厘秒日期时间：YYYY-MM-DDHH：MM：SS：FFF.FFF为宝秒数.数据类型记为DATET1.ME,长度为17, 金额：DDDDDDDD.DD.倍数部分最多为8位.小数点1位,小数部分为2位，若小数部分为0,则小数点和小数部分可以省略.计量单位为人民币元.数据类型记为DECWA1.,G大长度为11， 单价：DDDDDDDD.DD.整数部分最多为8位,小数点1位小数部分最多为2位，若小数部分为0,则小数点和小数部分可以省略，计/单位为人民币元。数据类型记为DEQMA1.,拼大长度为II, 数fit：DDDDDDDD.DD.8位整数，2为小数,小数部分为Q小数点和小数部分可以省略，最大长度11位，数据类型记为QUANTn'丫。 其他数据请参照数据字典.3.3 接口参数格式3.3.1 恳求参数恳求参数为标准Xv1.字符串，顶层节点名称为ReqUeSt,其卜节点包括头部Header及数据BOdy两部分，具体格式如下：REQUESTVHEADKR>VApPC'ODE>应用KEY<APPCODE><SESSION1.1.>><SESSION1.1.>>VMETHOD>求方法/METHOD<VERSI()>H口方法版本<VKRS1.oN>VSIG>数签名<SIG>VRKQTIM卜：>愚求时同<REQTIME>VREQTIMC卜：、0>流水号VREQTRACEN(>><HKAI)ER><BOI)Y><B()I)Y><REQUEST>标笠名数据类型中文名称必填项说明appCodeString恳求应用的Code是接入方应用安排的应用CodeSessionIdString会话ID或者Token是methodString恳求的方法是versionString接口版本否SignSiring参数签名否reqTimeString恳求时间裁是reqTraceNoString流水号是3.3.2 响应参数晌应参数为标准Xm1.字符曲.顶层节点名称为RCSPOnSa其下节点包括头部Header节点及响应数据BOdy两部分，具体格式如下：RESPONSE(HEADER)<CODE>fJftffif<CODE><MSG>结果描述"MSG><DETI1.>果具体描述VfDETA11.<RESPTME><RESPTME><HEADER><BODY><BODY><RESPONSF>标筌名数据类型中文名称必填项说明codeString结果值编码是见字典（提示信息msgString结果消息否见字典（提示信息）detai1.String结果具体描述否结果具体描述，错误时可以供应respTimeDateTime晌应时间是格式：yyyy-0n-ddHH：mm：ss备注当响应参数包括多个f项时子项内容父节点为i1.cms各子项内容笆点为诵E1.RESPONSE)<HEADER>头部公共响jSt<HEADMR><BOI)Y><1TEMS><1TEM><II)><D><NAME><NMK><TKM><ITEMS><BOOY><R1.SPOSE>3.4接口访问地址:/120.76,223.229:1080/SayifPfyWebSerViCe/FdaWsOutSideEntrance?wsd1.4接口逻辑结构设计4.1 微信预约平台接口架构4.2 体检业务监控接口架构体,凯杓械n伟校:务实“抬拄线I】5接口具体参数和格式5.1 数据签名验证5.1.1 数字签名生胜利能接口webservice接1方法Ca11Fun恩求方法（method）WO1.OO（见接口功能编号字典接11描述数字签名生成接口接口协议WebSerYiCexm1.加密算法MD55.1.1.1 恳求消息<REQUESr><HEAI>HR>头部公共恳求参数<HEANR>CBoDY><MET1IOD><METHOD><ORGC()I)E><ORGC()I)1.><USER><USER><PSSU'ORD><PSS'ORD><UUID><UUID><BOI>Y>/REQUEST标签名必填类型说明METHOD是String接口业务类型见接口功能编号字典）ORGCODE是String机构编码USER是String用户名PASSWORD是String用户接口密码，加密：MD5UUID是String系统对接前，安排给机构的UUn>,相当于身份唯一识别码5.1.1.2 返回消息<RESPONSE>CHE,U三>头部公共响应参数</HEAM：R><BOOY><SIGNAT1.REXZSIGNAniRE><BOY></RESPONSE>标笠名类型说明SIGNATUREString数字签名，该签名用于业务接口调用的认证码生成，数字签名具有时效性5.2 微信端接口5.2.1 体检机构信息接口webservice接口方法Ca1.IFUn恳求方法（method）COO1.OO（见接11功能编号字典）接口描述体检登记接口接口协议webservice+xm1加诙算法MD5+Base645.2.1.1 恳求信息<REQUEST>VHEADERA头部公找恳求参数<HEADER><BODY><METHODxzTvfETHOD><ORGCODExORGCODE><CHECKUUIDx>,CHECKUUID><SNAME><SNAME>VNAMEXNAME><ADDRESS><ADDRESS><,<BODY>REQUEST标签名是否必填类型说明METHOD½String接口业务类型（见接口功能端号字典）ORGCODE是String机构编码Checkuuid是String接口蛤证认证码，用于和服务器依证接口访问的合法性.该认证码依据数字签名以及参数俄排序相应规则生成SNAME否String机构简称NAME否String机构名称ADDRESS否String地址5.2.1.2 返回消息<RESW)NSE><HEADER>头部公共响应参数<HEADER><BODY>VRESU1.TXRESU1.T><REMESSAGE><REMESSAGE><ORG1D><.ORGID><STTUSXSTATUS><CODE><CODE><NME><NME><SNAME><SNAME><P1CxP1C><ORG-CODE><ORG_CODE><REG!ONX7REGION><ADDRESS><ADDRESS><HED><'HEAD><MOB!1.E><MOBI1.E><1.ATX1.AT><1.NG><1.NG><SUPERV!SEXSUPERV1SE><MTIME><.,MTIME>VRECOMMENDxJRECoMMEND><VORK_SCHEDU1.E>v/WORK_SCHEDU1.E>VSCoREXSCoRE><EVA1.,SCORE><yEVA1.SCORE><EV1.TIMES><.'EVA1.,TIMES><STAT1.SxSTATUS><BODY><RESPONSE>标筌名类型说明RESU1.TString接调用结果:SUeCESS,FAI1.ED,ERRORRIiMESSAGEString接11返回消息ORGIDString业务机构唯一码CODEString机构编码NAMEString机构名称SNAMEString机岗简称PICString图标ORG_CODEString医疗机构代码REGIONString所在地区ADDRESSString地址HEADString负或人MOBI1.EString联系电话1.ATString玮度1.NGString经度SUPERVISEString监管状态：非监管，I-监管MTIMEString启用时间RECOMMENDString举荐级别WORKSCHEDU1.StringE工作时间说明SCOREString评价分数：5EVA1.-SCOREString评价总分EVA1._TIMESString评级次数5.3体检系统接口5.3.1 体检登记WGbSCrYiC©接口方法Ca1.1.Fun恳求方法(method)COO1.OO(见接口功能编号字典接口描述体检曾记接口接口协议uebservice+xm1.加密算法W)5+Base641.1.1.1 恳求信息<REQUEST><HEADER>头部公共恳求参数<HEADER><BODY><METHOD><METHOD><ORGCODE><ORGCODE><CHECKUUIDx,CHECKUUID><ORGxORG><POS11ON><POS11ON><VEHIC1.E><VEHIC1.E><PNO><.PNO><ORDERx.ORDER>VoRDERTYPEXoRDERTYPE><NAMEx,NAME><IK,ARD><IDCARD><GENDERx,GENDER><AGEXAGE><ETHNICXETHNiC><HEADxHEAD><CAPHEAD><.CAPHEAD><FCEXFACE><MOB11.E><.TV1OBI1.E><OPEN1DXOPENID><TYPEx<YPE>VINDUSTRYXINDUSrRY><DEGREEXDEGREE><ORDERT1ME><ORDERT1ME><ENRO1.1.T1ME><FNROI.1.TIME><ENRO1.1.NO><ENRO1.1.NO><,<BODY>REQUEST标签名是否必填类型说明METHOD是String接口业务类型（见接口功能编写字典）ORGCODE是String机构编码Checkuuid是String接口蛤证认证码，用于和服务器依证接口访问的合法性，该认证码依据数字签名以及参数值排序相应规则生成ORG是String体检机构POSITION是String体检点VEHIC1.E否String体检车辆PNO是Siring*码前缀ORDER是String预约单ORDERTYPE是String订购类型：I个人,2团体，Mfi时加号NAME是String姓名IDCARD是String身份证号码GENDER是String性别AGE是String年龄ETHNIC是String民族HEAD二者选一String身份证头像BASEMCAPHEADSiring身份证无法识别脸状况，身份证拍照BASE64FACE是String登记面部BASE64MOBI1.E否String联系电话OPENID否String微信号TYPE是String行业类别大类：I:食品INDUSTRY是String行业类别小类DEGREE否String文化程度ORDERTIME是String预的时间Enro1.1.time是String登记时间Enro1.1.no是String登记号码,号码格式;yyMMddA(1.B3)(C(2)?.其中A为地点编号，B为序列号，C为域检编号，假如笈检.尾号则加】、2等纪检编号1.1.1.2 返回消息<RESPONSE><HEADER>头部公共响应参数VJHEADER><BODY>VRESU1.TXRESUm<REMESSAGEXREMESSAGE>VCERT1.DxJCERTID>VSTATUSXSTATUS><BODY><RESPONSE>标签名类型说明RESU1.TString接调用结果：SUCCESS,FAI1.ED,ERRORREMESSAGEString接口返回消息CERTIDString体检登记唯一码5.3.2 体检结果体检明细接口webservice接1方法Ca11Fun恳求方法(method)C00200(见接口功能编号字典接1.1.描述体检登记接口接口防议Wcbservice*xm1.加密算法MI)5+Basc645.3.2.1 恳求信息<REQUEST><HEADER>5k部公共总求参数/HEADER)<BODY><METHOD><METIIOD><ORGCODE><ORGCODE>Vcheckuuidxcheckuus<certxceri><TYPEX>TYPE><ITEM><ITEM><CHECK_T1.MEx.'CHECK_TIME><CHECK.NME><CHECK.NME><RESU1.1xRESU1.D<RESU1.T_TIMEXRESU1.T_TIME><RESU1.T.NMEXRESU1.T.NAME><CHECKUPT1.MEx,CHECKUPHME><RESU1.T_TIMFX.RESU1.T_TIMB><RESU1.Tx.RESU1.T<RESU1.T-NOE><RESU1.T-NOTE><DOCTOR><DOCTOR><VA1.ID><VA1.ID><1.IST><RECORD><CHECKxCHECK><ITEM><.'1TEM><RESU1.><RES1.1.T><DATA1><DATA1><DTA2><,DTA2><DATA3xDATA3><DAA4><DAA4><MEMO><MEMO><.'RECORD><1.IST><BODY>DREQUEST>标筌名是否必填类型说明METHOD是String接口业务类鞭（见接口功能端号字典）ORGCODE是String机构编码Checkuuid是String接口验证认证码，用于和服务器验证接口访问的合法性,该认证码依据数字签名以及参数Gi排序相应规则生成CERT是String健康证信总巾TYPE是String体检类别：O-初检1.更检ITEM是String体检项目大类Checkjime是String体检时间check.namE½String体检操作人RESU1.T是String结果：Y-合格、N-不合格、X-未出结果RESU1.TJnME是String结果时间RESU1.T_NAME½String结果录入人VA1.ID是String结果有效性Y-有效,N-无效.当红检结果录入时，把初检的结果设置为无效.CHECKUP.TIME是String体检时间RESU1.TJnME是Siring结论时间RESU1.T是String检查结论：Y-合格，N未合格RESU1.T_NoT是String检查结论说明EDOCTOR是String结论医师明细CHECK是String体检项目信息ITEM是String体检项目小类RESU1.T是String项目结果,Y-合格,N-不合格.S-可疑DATA1.否String预留字段DATA2否String预制字段DATA3否String预制字段DT4否String预例字段MEMO是String项目结果描述5.3.2.2 返回消息<RESPONSE>VHEADER)头部公共响应参数4HEADER)<BODY>VRESU1.TXRESU1.T><REMESSAGEXREMESSAGE><CHECKiDx/CHECKID>VSTATUSXSTATUS>vBODY><RESPONSE>标筌名类型说明RESU1.TString接O调用结果：SUCCESS,FAI1.ED,ERRORREMESSAGEString接口返回消息CiieckidString体检主表唯一ID5.3.3 健康证打印接口webservice接口方法Ca1.1.Fun.（&求方法（meihod）C00300（见接口功能编号字典接口描述体检曾记接口接口协议«ebservice+xm1.加密算法MD5÷Base645.3.3.1 恳求信息VREQUEST>VHEADERA头部公共恳求参数VHEADER><BODY><MEHOD><MEHOD>VoRGCODEXORGCODE)<CHECKUiDx'CHECKUUID><CERT><CER1><USER><USER><TIME><T1ME><NAMEXNAME><TEAM><TEAM><MOB!1.E><MOB11.E><1NDUSTRY><INDUSTRY><BODY>REQUEST,标签名是否会填类型说明MEFHOD是String接口业务类型（见接口功能嫔号字典）ORGCODE是String机构编码Checkuuid是String接口验证认证码,用于和服务器险证接口访问的合法性,该认证码依据数字签名以及参数位排序相应规则生成CERT是String健战证USER是String打印操作人TIME是String打印时间NAME是String健横证姓名TEAM是String所网团队MOBI1.E是String健康证联系方式INDUSTRY是String行业小类5.3.3.2 返回消息<RESPONSE>VHEADER>头部公共响应多数UHEADER><BODY><RESU1.TX,RESU1.T>VREAIESSAGE><remessage>VPRINTIDx/PRINTS<BODY><RESPONSE>标签名类型说明RESU1.TString接口调用结果：SUCCESS,FAI1.ED.ERRORREMESSAGEString接口返回消息PRINTIDString打印记录ID5.3.4 短信通知上传接口webservice接1方法Ca1.1.Eun恳求方法（IDethod）COO-100（见接口功能箱号字典接1.1.描述体检登记接口接1.1.协议webservice*xm1.加密算法MD5+Base645.3.4.1 恳求信息<REQUEST><HEADER>头部公共恩求参数/HEADER<BODY><METHOD><.'1.E11IOD><ORGCODE><ORGCODE><CHECKUUIDX,CHECKUU1D>VMOBIU><MOB11.E><CONTENT><ONTENT>IME><11ME><BODY>"REQUEST标签名是否必填蜘说明METHOD½String接口业务类型（见接11功能编号字典）ORGCODE是String机构编码Checku1.ud是String接口验证认证码.用于和服务滞验证接口访问的合法性，该认证码依据数字签名以及磐数做排序相应规则牛.成MOBI1.E½String手机号码CONTENT是String发送内容TIME是String发送晡间5.3.4.2 返回消息<RESPONSE>VHEADER>头部公共响附参数VjHEADER><BODY>vRESU1.TXRESU1.T><REMESSAGEXREMESSAGE><SMSID><SMS!D><STTUSXSTTUS><BODY><RESPONSE>标签名类型说明RESU1.TString接口调用结果：S11CCESS.FAI1.ED.ERRORREMESSAGEString接1.1.返回消息SMSIDString短信唯一码STATUSString状态：上待发送，卜已发送，2-发送失效5.3.5 验血人脸比对分析webservice接口方法Ca1.1.Fun恳求方法(method)C00700(见接口功能编号字典接1.1.描述验血人脸比对分析接口接口协议Wcbscrvice*xm1.加密算法MD5+Base645.3.5.1 恳求信息<REQUEST>VHEADER>头都公共恳求参<HEADER><BODY>VMETHOD><METHOD><ORGCODE><ORGCODE><CHECKUUIDX,CHECKUUID><MOB11.E><MOBI1.E>VCONTENT>vCONTEZ><TIME><.T1ME><BODY>REQUEST)标签名是否如K类型说明METHOD是String接口业务类里（见接口功能编号字典）ORGCODE是String机构编码Checkuuid是String接口验证认证码，用于和服务器验证接口访问的合法性，该认证码依据数字签名以及卷故使排序相应规则生成NAME是String姓名IDcARD是String身份证号码IDHEAD是String身份证头像BASE64Enro1.1.head是String登记头像BASE64B1.OODFCE是String来血登记面部BASE645.3.5.2 返回消息<RESPONSE>（HEADER头部公共响府参数VHEADER）<BODY>vRESU1.TXRESU1.T><REMESSAGE><REMESSAGE><SMSID><.'SMS1D>VSTATUSxySrATus><BODY><RESPONSE>标签名类型说明RESU1.TString接口调用果；SUCCESS,FAI1.ED,ERRORREMESSACEString接匚I返回消息Resu1.tidString比对结果唯一码resu1.tString比对结果:PAS$,FAI1.EDSIMI1.ARITYString比对相像度6附录：字典6.1接口功能编号简要描述功能M1.hOd编码说明功能编码功能名称900100数字签名生胜利能接口COO1.OO体检机构信息接口COO300体检登记接口COOtOO体检结果体检明细接口C00500健康证打印接口C00600短信通知上传接口C00700验血人脍比对分析接口
