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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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