EMS自助服務(wù)系統(tǒng)和大客戶接口規(guī)范變更歷史日期變更描述版本號(hào)變更人批準(zhǔn)2013-03-18創(chuàng)建文檔V0.9王一松1 總體說明1.1 接口目的本文包含了相關(guān)接口的數(shù)據(jù)格式、通訊格式。本文附錄包含了接口使用的基礎(chǔ)代碼信息。該文檔約束了中國郵政速遞物流EMS自助服務(wù)系統(tǒng)和大客戶的接口規(guī)范，文檔內(nèi)容需嚴(yán)格保密。1.2 接口規(guī)范EMS自助服務(wù)系統(tǒng)和大客戶接口建議采用http接口方式，同時(shí)支持webservice接口方式；http接口編碼格式均為UTF-8格式。為保證單號(hào)正常獲取，不影響用戶使用。需在當(dāng)天將打印后的數(shù)據(jù)更新到EMS自助服務(wù)系統(tǒng)（接口2.2）。2 EMS自助服務(wù)客戶端和大客戶接口規(guī)范2.1 根據(jù)大客戶號(hào)、業(yè)務(wù)類型獲取詳情單號(hào)接口功能描述通過大客戶號(hào)，業(yè)務(wù)類型獲取詳情單號(hào)服務(wù)端EMS自助服務(wù)系統(tǒng)客戶端大客戶系統(tǒng)接口方式HTTP接口地址:8081/zkweb/bigaccount/getBigAccountDataAction.do?method=getBillNumBySys&xml=輸入?yún)?shù)大客戶號(hào)、密碼、業(yè)務(wù)種類、獲取數(shù)量輸入?yún)?shù)格式定義使用BASE64加密輸入?yún)?shù)！特別注意：單號(hào)是唯一的，獲取后本地保存時(shí)必須作為唯一索引。！XML標(biāo)記串：/大客戶號(hào)，必填，代碼調(diào)試期間請(qǐng)務(wù)必傳入大客戶號(hào)：A1234567890Z/大客戶密碼，必填，小寫md5加密，e10adc3949ba59abbe56e057f20f883e/對(duì)接方平臺(tái)id，作為接口調(diào)用方的身份憑據(jù)，由接口提供方提供/業(yè)務(wù)類型，必填，1為標(biāo)準(zhǔn)快遞，4為經(jīng)濟(jì)快遞（傳數(shù)字）需要詳情單數(shù)量，最多輸入100個(gè)字段類型Limit說明訂單信息sysAccountVARCHAR2(20 CHAR)NotNull大客戶號(hào)passWordVARCHAR2(40 CHAR)Not Null密碼（MD5 加密，全小寫，32位）appKeyVARCHAR2(20 CHAR)平臺(tái)id，暫時(shí)留空billNoAmountVARCHAR2(5 CHAR)Not Null 請(qǐng)求數(shù)量（1-100）返回值格式定義使用BASE64加密返回值XML標(biāo)記串：/是否執(zhí)行成功，1是成功，0是失敗/錯(cuò)誤原因描述 /詳情單號(hào) . .參考方法名getBillNoBySys(xml)Webservice_path:8081/zkweb/services/getPrintDatas?wsdlWebservice_name實(shí)現(xiàn)類EmsPrintService備注2.2 詳情單打印信息更新到EMS自助服務(wù)系統(tǒng)接口功能描述將詳情單打印信息更新到自助服務(wù)系統(tǒng)服務(wù)端EMS自助服務(wù)系統(tǒng)客戶端大客戶系統(tǒng)接口方式HTTP接口地址:8081/zkweb/bigaccount/getBigAccountDataAction.do?method=updatePrintDatas&xml=輸入?yún)?shù)大客戶號(hào)、打印類型將詳情單信息按照xml格式封裝成一個(gè)字符串傳入系統(tǒng)進(jìn)行數(shù)據(jù)更新輸入?yún)?shù)格式定義使用BASE64加密輸入?yún)?shù)XML標(biāo)記串：/大客戶號(hào)，必填/大客戶密碼，必填，小寫md5加密，e10adc3949ba59abbe56e057f20f883e/對(duì)接方平臺(tái)id，作為接口調(diào)用方的身份憑據(jù)，由接口提供方提供/打印類型，1為五聯(lián)單打印，2為熱敏打印，必填 /大客戶數(shù)據(jù)的唯一標(biāo)識(shí)，如某電商公司的配貨單號(hào)，必填(訂單如果打印條碼,應(yīng)為非13位數(shù)字) /詳情單號(hào)，和配貨單號(hào)對(duì)應(yīng)，必填（詳情單號(hào)打印條形碼必須128碼）/寄件人姓名/寄件人聯(lián)系方式1/寄件人聯(lián)系方式2(選填) /寄件人郵編/寄件人地址 /寄件人公司/收件人姓名/收件人聯(lián)系方式1/收件人聯(lián)系方式2(選填)/收件人郵編/收件人地址 /收件人公司 /到件省 /到件市 /到件縣 /寄件重量 /物品長度 保價(jià)，每件最高投保金額以人民幣5萬元為限 /保險(xiǎn) /小寫金額，代收貨款和收件人付費(fèi)不保留小數(shù)點(diǎn)；標(biāo)準(zhǔn)快遞和經(jīng)濟(jì)快遞保留兩位小數(shù)點(diǎn) /大寫金額（代收貨款和收件人付費(fèi)需要填寫） /業(yè)務(wù)類型，1為標(biāo)準(zhǔn)快遞，2為代收貨款，3為收件人付費(fèi)，4為經(jīng)濟(jì)快遞（傳數(shù)字） /內(nèi)件信息，根據(jù)貨品的實(shí)際情況填寫（對(duì)個(gè)別已與EMS和買家達(dá)成協(xié)議的，可只寫貨號(hào)，不寫實(shí)際貨物名稱） /內(nèi)件類型：（文件、物品） /備注 /對(duì)攬投員的投遞要求，填寫客戶的個(gè)性化投遞要求 /產(chǎn)品代碼 /預(yù)留字段1 /預(yù)留字段2 /預(yù)留字段3 /預(yù)留字段4 /預(yù)留字段5 .字段類型Limit說明訂單信息scontactorVARCHAR2(50 CHAR)NotNull寄件人姓名scustMobileVARCHAR2(20 CHAR)Not Null寄件人聯(lián)系方式1scustTelplusVARCHAR2(20 CHAR)寄件人聯(lián)系方式2scustPostVARCHAR2(6 CHAR)Not Null寄件人郵編scustAddrVARCHAR2(200 CHAR)Not Null 寄件人地址scustCompVARCHAR2(50 CHAR)寄件人公司tcontactorVARCHAR2(50 CHAR)Not Null收件人姓名tcustPostVARCHAR2(6 CHAR)Not Null收件人郵編tcustAddrVARCHAR2(200 CHAR)Not Null收件人地址tcustCompVARCHAR2(50 CHAR)收件人公司tcustMobileVARCHAR2(30 CHAR)Not Null收件人聯(lián)系方式1tcustTelplusVARCHAR2(30CHAR)收件人聯(lián)系方式2tcustProvinceVARCHAR2(20 CHAR)Not Null到件省tcustCityVARCHAR2(20 CHAR)Not Null到件市tcustCountyVARCHAR2(20 CHAR)Not Null到件縣weightNUMBER(14,4)寄件重量lengthNUMBER(14,4)物品長度RemarkVARCHAR2(100 CHAR)備注bigAccountDataIdVARCHAR2(30 CHAR)Not Null大客戶數(shù)據(jù)的唯一標(biāo)識(shí)，如某電商公司的配貨單號(hào)billnoVARCHAR2(20 CHAR)Not Null詳情單號(hào)customerDnVARCHAR2(30 CHAR)大客戶數(shù)據(jù)的客戶訂單號(hào)，主要是對(duì)于電商客戶有用insureNUMBER(14,4)保價(jià)insuranceNUMBER(14,4)保險(xiǎn)feeNUMBER(14,4)小寫金額feeUppercaseVARCHAR2(20 CHAR)大寫金額deliveryclaimVARCHAR2(100 CHAR)對(duì)攬投員的投遞要求businessTypeVARCHAR2(10 CHAR)業(yè)務(wù)種類cargoDescVARCHAR2(100 CHAR)內(nèi)件信息cargoTypeVARCHAR2(10CHAR)內(nèi)件類型productCodeVARCHAR2(20CHAR)產(chǎn)品代碼blank1VARCHAR2(100 CHAR)預(yù)留字段1blank2VARCHAR2(100 CHAR)預(yù)留字段2blank3VARCHAR2(100 CHAR)預(yù)留字段3blank4VARCHAR2(100 CHAR)預(yù)留字段4blank5VARCHAR2(100 CHAR)預(yù)留字段5返回值格式定義使用BASE64加密返回值XML標(biāo)記串：/是否執(zhí)行成功，1是成功，0是失敗/錯(cuò)誤原因描述參考方法名updatePrintEMSDatas(xml)Webservice_path:8081/zkweb/services/getPrintDatas?wsdlWebservice_name實(shí)現(xiàn)類EmsPrintService備注3 OCX接口3.1 調(diào)用身份驗(yàn)證程序加載OCX過程中調(diào)用一次本方法即可，相當(dāng)于登陸。功能描述大客戶系統(tǒng)調(diào)用EMS自助服務(wù)系統(tǒng)OCX身份驗(yàn)證接口方式OCX接口地址EmsPrint.ocx（在EMS自助服務(wù)客戶端安裝根目錄下）輸入?yún)?shù)大客戶號(hào)，密碼(小寫MD5加密)輸入?yún)?shù)格式定義單個(gè)字符串，使用#%分隔不同參數(shù)參數(shù)示例：大客戶號(hào)#%密碼(小寫MD5加密)A1234567890Z#%e10adc3949ba59abbe56e057f20f883e返回值格式定義單個(gè)字符串，使用#%分隔不同返回值字段返回值示例驗(yàn)證成功：1#%驗(yàn)證成功#%寄件城市驗(yàn)證失敗：0#%錯(cuò)誤代碼#%錯(cuò)誤信息參考方法名CheckID ()錯(cuò)誤信息定義0#%網(wǎng)絡(luò)連接失敗0#%該用戶不存在0#%ocx版本不一致,請(qǐng)更新客戶端并登錄一次后使用0#%當(dāng)前版本.0#%密碼錯(cuò)誤0#%其他錯(cuò)誤#%錯(cuò)誤信息備注3.2 獲取郵件號(hào)種類及郵件產(chǎn)品代碼功能描述大客戶系統(tǒng)調(diào)用EMS自助服務(wù)系統(tǒng)OCX打印詳情單接口方式OCX接口地址EmsPrint.ocx（在EMS自助服務(wù)客戶端安裝根目錄下）輸入?yún)?shù)head|開頭，|end結(jié)尾，參數(shù)字段以|分隔拼接的字符串，空值也需要用|占位。拼接完成后將整個(gè)字符串傳入接口輸入?yún)?shù)格式定義字符串，head|開頭，|end結(jié)尾。各字段值使用|（英文豎線）分隔。拼接完成后使用整個(gè)字符串作為接口參數(shù)。空值也需要用|占位businessType - 業(yè)務(wù)類型，1為標(biāo)準(zhǔn)快遞，2為代收貨款，3為收件人付費(fèi)，4為經(jīng)濟(jì)快遞，不可傳空cargo_type - 內(nèi)件性質(zhì)，3為物品，1為文件,傳空默認(rèn)為物品tcustProvince - 到件省tcustCity - 到件市tcustCounty - 到件縣輸入?yún)?shù)示例head|businessType|cargo_type|tcustProvince|tcustCity|tcustCounty|end返回值格式定義單個(gè)字符串，使用#%分隔不同返回值字段返回值參數(shù)格式如下：1#%單號(hào)類型#%產(chǎn)品代碼返回值說明單號(hào)類型：1、標(biāo)快單號(hào)（11開頭），2、經(jīng)快單號(hào)（51開頭）參考方法名getprtInfo(prtData)錯(cuò)誤信息定義E007：請(qǐng)驗(yàn)證賬號(hào)后使用E011：參數(shù)錯(cuò)誤E999：錯(cuò)誤信息(其他錯(cuò)誤)備注3.3 大客戶系統(tǒng)調(diào)用客戶端OCX打印詳情單功能描述大客戶系統(tǒng)調(diào)用EMS自助服務(wù)系統(tǒng)OCX打印詳情單接口方式OCX接口地址EmsPrint.ocx（在EMS自助服務(wù)客戶端安裝根目錄下）輸入?yún)?shù)head|開頭，|end結(jié)尾，參數(shù)字段以|分隔拼接的字符串，空值也需要用|占位。拼接完成后將整個(gè)字符串傳入接口輸入?yún)?shù)格式定義字符串，head|開頭，|end結(jié)尾。各字段值使用|（英文豎線）分隔。拼接完成后使用整個(gè)字符串作為接口參數(shù)?？罩狄残枰脇占位businessType - 業(yè)務(wù)類型，1為標(biāo)準(zhǔn)快遞，2為代收貨款，3為收件人付費(fèi)，4為經(jīng)濟(jì)快遞，不可傳空billnoType - 單號(hào)類型，1為標(biāo)快，2為經(jīng)快，“業(yè)務(wù)類型”為“代收貨款”、“收件人付費(fèi)”時(shí)不可傳空Billno - 詳情單號(hào)（運(yùn)單號(hào)、郵件號(hào)）dateType - 時(shí)間類型，1為收寄時(shí)間 ；2為打印時(shí)間 ；可傳空Procdate - 收寄時(shí)間或打印時(shí)間，形式如“YYYY-MM-DD hh:mi:ss”，可精確到“秒”，時(shí)間類型為空時(shí)，本值可為空也可進(jìn)行傳值。scontactor - 寄件人姓名scustMobile - 寄件人聯(lián)系方式1scustTelplus - 寄件人聯(lián)系方式2(選填)scustPost - 寄件人郵編scustAddr - 寄件人地址tcontactor - 收件人姓名tcustMobile - 收件人聯(lián)系方式1tcustTelplus - 收件人聯(lián)系方式2(選填)tcustPost - 收件人郵編tcustAddr - 收件人地址tcustProvince - 到件省tcustCity - 到件市tcustCounty - 到件縣weight - 寄件重量insure - 保價(jià)，每件最高投保金額以人民幣5萬元為限fee - 小寫金額，代收貨款和收件人付費(fèi)不保留小數(shù)點(diǎn)；標(biāo)準(zhǔn)快遞和經(jīng)濟(jì)快遞保留兩位小數(shù)點(diǎn)feeUppercase - 大寫金額（代收貨款和收件人付費(fèi)需要填寫）cargoDesc - 內(nèi)件信息，根據(jù)貨品的實(shí)際情況填寫（對(duì)個(gè)別已與EMS和買家達(dá)成協(xié)議的，可只寫貨號(hào)，不寫實(shí)際貨物名稱）bigAccountDataId - 大客戶數(shù)據(jù)的唯一標(biāo)識(shí)，如某電商公司的配貨單號(hào)customerDn - 大客戶數(shù)據(jù)的客戶訂單號(hào)，主要是對(duì)于電商客戶有用）mainBillNo - 主單郵件號(hào)，分單對(duì)應(yīng)的主單郵件號(hào)，可為空blank1 - 留白1blank2 - 留白2字段類型Limit說明訂單信息businessTypeVARCHAR2(2 CHAR)Not Null業(yè)務(wù)類型billnoTypeVARCHAR2(2 CHAR)Not Null單號(hào)類型BillnoVARCHAR2(16 CHAR)Not Null詳情單號(hào)dateTypeVARCHAR2(2 CHAR)時(shí)間類型procdateVARCHAR2(16 CHAR)時(shí)間值scontactorVARCHAR2(50 CHAR) Not Null寄件人姓名scustMobileVARCHAR2(12 CHAR)Not Null寄件人聯(lián)系方式1scustTelplusVARCHAR2(12 CHAR)寄件人聯(lián)系方式2scustPostVARCHAR2(6 CHAR)Not Null寄件人郵編scustAddrVARCHAR2(200 CHAR)Not Null 寄件人地址tcontactorVARCHAR2(50 CHAR)Not Null收件人姓名tcustMobileVARCHAR2(30CHAR)Not Null收件人聯(lián)系方式1tcustTelplusVARCHAR2(30CHAR)收件人聯(lián)系方式2tcustPostVARCHAR2(6 CHAR)Not Null收件人郵編tcustAddrVARCHAR2(200 CHAR)Not Null收件人地址tcustProvinceVARCHAR2(20 CHAR)Not Null到件省tcustCityVARCHAR2(20 CHAR)Not Null到件城市tcustCountyVARCHAR2(20 CHAR)Not Null到件縣weightNUMBER(14,4)寄件重量insureNUMBER(14,4)保價(jià)feeNUMBER(14,4)小寫金額feeUppercaseVARCHAR2(20 CHAR)大寫金額cargoDescVARCHAR2(100 CHAR)內(nèi)件信息bigAccountDataIdVARCHAR2(30 CHAR)Not Null大客戶數(shù)據(jù)的唯一標(biāo)識(shí)，如某電商公司的配貨單號(hào)customerDnVARCHAR2(30 CHAR)大客戶數(shù)據(jù)的客戶訂單號(hào)，主要是對(duì)于電商客戶有用mainBillNoVARCHAR2(20 CHAR)主單郵件號(hào)，可為空blank1VARCHAR2(100 CHAR)留白1blank2VARCHAR2(100 CHAR)留白2輸入?yún)?shù)示例head|businessType|billnoType|Billn