廣東食品從業(yè)人員.doc

1、廣東省食品從業(yè)人員健康檢查管理平臺接口規(guī)范文檔2017-11改版記錄版本發(fā)布日期描述作者復審批準1.02017/11/24建立該文檔，初稿變更記錄變更編號日期變更項描述基線版本變更請求編號目錄1 概述 42 適用范圍 43 接口概述 43.1 接口概述 43.2 數(shù)據(jù)類型與格式 53.3 接口參數(shù)格式 53.3.1 請求參數(shù) 53.3.2 響應參數(shù) 63.4 接口訪問地址 84 接口邏輯結(jié)構設計 84.1 微信預約平臺接口架構 84.2 體檢業(yè)務監(jiān)控接口架構 85 接口詳細參數(shù)和格式 95.1 數(shù)據(jù)簽名驗證 95.1.1 數(shù)字簽名生成功能接口 95.2 微信端接口 105.2.1 體檢機構信息

2、接口 105.3 體檢系統(tǒng)接口 135.3.1 體檢登記 135.3.2 體檢結(jié)果體檢明細接口 165.3.3 健康證打印接口 195.3.4 短信通知上傳接口 21廣東省食品從業(yè)人員健康檢查管理平臺接口規(guī)范文檔1概述健康證管理平臺按照省局關于體檢機構現(xiàn)場巡查和體檢業(yè)務實時監(jiān) 控的要求制定。目的是實時獲取體檢機構的實時業(yè)務監(jiān)控數(shù)據(jù)，保證服 務業(yè)從業(yè)人員的體檢信息的真實性。主要實時監(jiān)控如下：體檢機構體檢系統(tǒng)和省平臺實時上傳數(shù)據(jù)1體檢登記.2抽血登記3體檢結(jié)果4體檢打印5短信通知1身份證相片V_-_,$人臉核驗相片、/體檢結(jié)果打印記錄短信通知1/人臉核驗相片省平臺業(yè)務串檢驗明細體檢結(jié)果二維碼短信通

3、知明細-Xs_省平臺業(yè)務串健康證管理平臺提供 Webservice接口應用服務，供各接入系統(tǒng)訪問 調(diào)用。在調(diào)用時，需按照本文檔規(guī)定格式拼裝參數(shù)，傳入?yún)?shù)調(diào)用平臺 端webservice接口，接收 webservice接口獲取返回信息。各接入系統(tǒng) 將返回信息進行解析后供自身系統(tǒng)處理使用。2適用范圍本文檔主要用于描述 Webservice接口的定義、調(diào)用說明。文檔可供 接入健康證管理平臺的各系統(tǒng)建設方、開發(fā)方閱讀及使用。3接口概述3.1接口概述健康證管理平臺作為服務端，以 WebService方式為各個第三方系統(tǒng) 等提供接口服務。接口采用SOAP協(xié)議，請求方在請求時以base64加密 入?yún)?，服務?/p>

4、解密處理，返回base64加密回參，請求端自行解密使用。WebService接口統(tǒng)一入口方法為 CalIFun，通過method參數(shù)進行業(yè)務區(qū)分3.2數(shù)據(jù)類型與格式如無特殊說明，本文檔中的部分數(shù)據(jù)均為以下格式：日期： YYYY-MM-DD ，即 4 位年， 2位月份， 2 位日期。數(shù)據(jù)類型記為 DATE ，長度為 10。時間： HH ：MM:SS ，即 2位小時（ 24小時制）， 2為分鐘， 2為秒。數(shù)據(jù) 類型記為 TIME ，長度為 6.日期時間： YYYY-MM-DD HH ：MM:SS 。數(shù)據(jù)類型記為 DATETIME ，長 度為 19.帶毫秒日期時間： YYYY-MM-DD HH ：M

5、M ： SS： FFF。 FFF 為毫秒數(shù)。 數(shù)據(jù)類型記為 DATETIME ，長度為 17 。金額： DDDDDDDD.DD ，整數(shù)部分最多為 8 位，小數(shù)點 1位，小數(shù)部分為 2 位，若小數(shù)部分為 0 ，則小數(shù)點和小數(shù)部分可以省略。計量單位為人民幣元。 數(shù)據(jù)類型記為 DECIMAL ，最大長度為 11。單價： DDDDDDDD.DD, ，整數(shù)部分最多為 8位，小數(shù)點 1 位，小數(shù)部分 最多為 2 位，若小數(shù)部分為 0，則小數(shù)點和小數(shù)部分可以省略。計量單位為人 民幣元。數(shù)據(jù)類型記為 DECIMAL ，最大長度為 11。數(shù)量： DDDDDDDD.DD ，8 位整數(shù)， 2 為小數(shù)。小數(shù)部分為 0

6、，小數(shù)點和 小數(shù)部分可以省略，最大長度 11 位。數(shù)據(jù)類型記為 QUANTITY 。其他數(shù)據(jù)請參照數(shù)據(jù)字典。3.3接口參數(shù)格式3.3.1 請求參數(shù)請求參數(shù)為標準XML字符串，頂層節(jié)點名稱為 Request，其下節(jié)點包 括頭部 Header 及數(shù)據(jù) Body 兩部分，具體格式如下：應用 KEY VMETHOD 請求方法 V/METHOD VVERSION 接口方法版本 V/VERSION VSIGN 參數(shù)簽名 V/SIGN VREQ TIME 請求時間 V/REQTIME VREQ TRACE NO流水號 V/REQ TRACE NOV/HEADER VBODY V/BODY V/REQUEST

7、 標簽名數(shù)據(jù)類型中文名稱必填項說明appCodeStri ng請求應用的Code是接入方應用分配的應用Codesessi onldStri ng會話ID或者Toke n是methodStri ng請求的方法是versi onStri ng接口版本否signStri ng參數(shù)簽名否reqTimeStri ng請求時間戳是reqTraceNoStri ng流水號是332響應參數(shù)響應參數(shù)為標準 Xml字符串，頂層節(jié)點名稱為Response,其下節(jié)點包括頭部Header節(jié)點及響應數(shù)據(jù) Body兩部分，具體格式如下：VRESPONSE 結(jié)果值編碼 結(jié)果描述 VDETAIL 結(jié)果詳細描述 VRESPTIM

8、E VBODY V/BODY 標簽名數(shù)據(jù)類型中文名稱必填項說明codeStri ng結(jié)果值編碼是見字典（提示信息）msgStri ng結(jié)果消息否見字典（提示信息）detailStri ng結(jié)果詳細描述否結(jié)果詳細描述，錯誤時可以提供respTimeDateTime響應時間是格式:yyyy-mm-dd HH: mm ss*備注當響應參數(shù)包括多個子項時，子項內(nèi)容父節(jié)點為items，各子項內(nèi)容節(jié)點為item。VRESPONSE VHEADER 頭部公共響應參數(shù) V/HEADER VBODY VlTEMS VlTEM VlD V/ID VNAME V/ NAME V/ITEM V/ITEMS V/BOD

9、Y V/RESPONSE 3.4接口訪問地址 ntr an ce?wsdl4接口邏輯結(jié)構設計4.1微信預約平臺接口架構互聯(lián)網(wǎng)體檢機構接口微信公眾號接口機構調(diào)用數(shù)據(jù)上傳機構信息接口機構信息接口機構調(diào)用數(shù)據(jù)上傳體檢預約排班接口體檢預約排班接口機構調(diào)用數(shù)據(jù)上傳機構身份認證接口機構身份認證接口機構輪詢調(diào)用數(shù)據(jù)上傳消息通知接口消息通知接口接口用尸管理體檢機構業(yè)務系統(tǒng)接口調(diào)用日志接口申請審核接口服務統(tǒng)計查詢微信公眾號接口管理微信公眾號平臺省健康證管理平臺4.2體檢業(yè)務監(jiān)控接口架構互聯(lián)網(wǎng)體檢機構接口體檢業(yè)務實時監(jiān)控接口機構調(diào)用數(shù)據(jù)上傳實時業(yè)務驗證串實時業(yè)務驗證串機構調(diào)用數(shù)據(jù)上傳人臉核驗數(shù)據(jù)接口機構調(diào)用數(shù)據(jù)上

10、傳體檢結(jié)果和明細接口體檢結(jié)果和明細接口機構調(diào)用數(shù)據(jù)上傳體檢表打印信息接口體檢表打印接口機構輪詢調(diào)用數(shù)據(jù)上傳消息通知接口身份讀卡器登記生化儀設備登記酶標儀設備登記接口申請審核查詢統(tǒng)計分析身份證、人臉核驗數(shù)據(jù) 接口1 彳* 體檢機構業(yè)1務系統(tǒng):消息通知接口人臉識別系統(tǒng)登記5體檢機構登記功能省健康證管理平臺5接口詳細參數(shù)和格式5.1數(shù)據(jù)簽名驗證數(shù)字簽名生成功能接口webservice 接口方法CalIFu n請求方法（method）900100 （見接口功能編號字典）接口描述數(shù)字簽名生成接口接口協(xié)議webservice+xml加密算法MD55.1.1.1 請求消息VHEADE段頭部公共請求參數(shù) /

11、HEADER. 標簽名必填類型說明METHOD是Stri ng接口業(yè)務類型（見接口功能編號字典）ORGCODE是Stri ng機構編碼USER是Stri ng用戶名PASSWORD是Stri ng用戶接口密碼，加密：MD5UUID是Stri ng系統(tǒng)對接前，分配給機構的UUID,相當于身份唯一識別 碼5.1.1.2 返回消息HEADE金頭部公共響應參數(shù) / HEADER-標簽名類型說明SIGNATUREStri ng數(shù)字簽名，該簽名用于業(yè)務接口調(diào)用的認證碼生成，具有時效性數(shù)字簽名5.2微信端接口體檢機構信息接口CallFunC00100 （見接口功能編號字典）webservice 接口方法請求

12、方法（method）接口描述體檢登記接口接口協(xié)議webservice+xml加密算法MD5+Base64521.1 請求信息頭部公共請求參數(shù) 標簽名是否必填類型說明METHOD是Stri ng接口業(yè)務類型（見接口功能編號字典）ORGCODE是Stri ng機構編碼CHECKUUID是Stri ng接口驗證認證碼，用于和服務器驗證接口訪問的合法性，該認證碼依據(jù)數(shù)字簽名以及參數(shù)值排序相應規(guī)則生成SNAME否Stri ng機構簡稱NAME否Stri ng機構名稱ADDRESS否Stri ng地址5.2.1.2 返回消息頭部公共響應參數(shù) 標簽名類型說明RESULTStri ng接口調(diào)用結(jié)果：SUCCE

13、SS,FAILED,ERRORREMESSAGEStri ng接口返回消息ORGIDStri ng業(yè)務機構唯一碼CODEStri ng機構編碼NAMEStri ng機構名稱SNAMEStri ng機構簡稱PICStri ng圖標ORG_CODEStri ng醫(yī)療機構代碼REGIONStri ng所在地區(qū)ADDRESSStri ng地址HEADStri ng負責人MOBILEStri ng聯(lián)系電話LATStri ng緯度LNGStri ng經(jīng)度SUPERVISEStri ng監(jiān)管狀態(tài)：0-非監(jiān)管，1-監(jiān)管MTIMEStri ng啟用時間RECOMMENDStri ng推存級別WORK_SCHES

14、tri ngE工作時間說明DULSCOREStri ng評價分數(shù)：05EVAL_SCOREStri ng評價總分EVAL_TIMESStri ng評級次數(shù)5.3體檢系統(tǒng)接口體檢登記webservice 接口方法CalIFu n請求方法（method）C00100 （見接口功能編號字典）接口描述體檢登記接口接口協(xié)議webservice+xml加密算法MD5+Base64531.1 請求信息頭部公共請求參數(shù) 標簽名是否必填類型說明METHOD是Stri ng接口業(yè)務類型（見接口功能編號字典）ORGCODE是Stri ng機構編碼CHECKUUID是Stri ng接口驗證認證碼，用于和服務器驗證接口

15、訪問的合法性，該認證碼依據(jù)數(shù)字簽名以及參數(shù)值排序相應規(guī)則生成ORG是Stri ng體檢機構POSITION是Stri ng體檢點VEHICLE否Stri ng體檢車輛PNO是Stri ng編碼前綴ORDER是Stri ng預約單ORDERTYPE是Stri ng訂購類型：1-個人，2-團體，3-臨時加號NAME是Stri ng姓名IDCARD是Stri ng身份證號碼GENDER是Stri ng性別AGE是Stri ng年齡ETHNIC是Stri ng民族HEAD二者選一Stri ng身份證頭像 BASE64CAPHEADStri ng身份證無法識別臉情況，身份證拍照 BASE64FACE是S

16、tri ng登記面部BASE 64MOBILE否Stri ng聯(lián)系電話OPENID否Stri ng微信號TYPE是Stri ng行業(yè)類別大類：1:食品INDUSTRY是Stri ng行業(yè)類別小類DEGREE否Stri ng文化程度ORDERTIME是Stri ng預約時間ENROLLTIME是Stri ng登記時間ENROLLNO是Stri ng登記號碼，號碼格式：yyMMddA1B3（C2）?，其中 A 為地點編號，B為序列號，C為復檢編號，如果復檢， 尾號則加-1、-2等復檢編號531.2 返回消息頭部公共響應參數(shù) 標簽名類型說明RESULTStri ng接口調(diào)用結(jié)果：SUCCESS,FA

17、ILED,ERRORREMESSAGEStri ng接口返回消息CERTIDStri ng體檢登記唯一碼體檢結(jié)果體檢明細接口webservice 接口方法CallFu n請求方法（method）C00200 （見接口功能編號字典）接口描述體檢登記接口接口協(xié)議webservice+xml加密算法MD5+Base645.3.2.1 請求信息 頭部公共請求參數(shù) 標簽名是否必填類型說明METHOD是Stri ng接口業(yè)務類型（見接口功能編號字典）ORGCODE是Stri ng機構編碼CHECKUUID是Stri ng接口驗證認證碼，用于和服務器驗證接口訪問 的合法性，該認證碼依據(jù)數(shù)字簽名以及參數(shù)值 排

18、序相應規(guī)則生成CERT是Stri ng健康證信息IDTYPE是Stri ng體檢類別：0-初檢，1-復檢ITEM是Stri ng體檢項目大類CHECK_TIME是Stri ng體檢時間CHECK_NAME是Stri ng體檢操作人RESULT是Stri ng纟口果：Y-合格、N-不合格、X-未出纟口果RESULT_TIME是Stri ng結(jié)果時間RESULT_NAME是Stri ng結(jié)果錄入人VALID是Stri ng結(jié)果有效性，Y-有效，N-無效，當復檢結(jié)果錄 入時，把初檢的結(jié)果設置為無效。CHECKUP_TIME是Stri ng體檢時間RESULT_TIME是Stri ng結(jié)論時間RESU

19、LT是Stri ng檢查結(jié)論：Y-合格，N-未合格RESULT_NOT是Stri ng檢查結(jié)論說明EDOCTOR是Stri ng結(jié)論醫(yī)師明細CHECK是Stri ng體檢項目信息ITEM是Stri ng體檢項目小類RESULT是Stri ng項目結(jié)果，Y-合格，N-不合格，S-可疑DATA1否Stri ng預留字段DATA2否Stri ng預留字段DATA3否Stri ng預留字段DATA4否Stri ng預留字段MEMO是Stri ng項目結(jié)果描述5.322返回消息頭部公共響應參數(shù) 標簽名類型說明RESULTStri ng接口調(diào)用結(jié)果:SUCCESS,FAILED,ERRORREMESSAGEStri ng接口返回消息CHECKIDStri ng體檢主表唯一ID健康證打印接口請求方法（method）C00300 （見接口功能編號字典）接口描述體檢登記接口接口協(xié)議webservice+xml加密算法MD5+Base64webservice 接口方法CallFun533.1 請求信息頭部公共請求參數(shù) 標簽名是否必填類型說明METHOD是Stri ng接口業(yè)務類型（見接口功能編號字典）ORGCODE是Stri ng機構編碼CHECKUUID是Stri ng接口驗證認證碼，用于和服務器驗證接口訪問的合法性，該認證碼依據(jù)數(shù)字簽名以及參數(shù)值排序相應規(guī)則生成CERT