歐飛Sup供貨接口V2.2

1、歐飛sup供貨系統(tǒng)供貨接口規(guī)范 江蘇歐飛電子商務(wù)有限公司2012年6月28日version：v2.2文檔管理記錄修 改修 改 者版 本2012/04/20建立文檔歐飛sup運(yùn)營(yíng)團(tuán)隊(duì)v2.02012/05/21返回充值結(jié)果時(shí)增加模板編號(hào)參數(shù)歐飛sup運(yùn)營(yíng)團(tuán)隊(duì)v2.12012/06/28新增返回頻繁請(qǐng)求狀態(tài)碼7777歐飛sup運(yùn)營(yíng)團(tuán)隊(duì)v2.22012/06/28 v2.2更新說明： 接口參數(shù)中新增返回頻繁請(qǐng)求狀態(tài)碼7777，默認(rèn)訪問時(shí)間為5秒每次，如供貨商訪問頻繁則 會(huì)提示7777錯(cuò)誤。2012/05/25 v2.1更新說明： 接口參數(shù)中增加模版編號(hào)值，支持自定義模版中配置的商品充值策略，自動(dòng)觸發(fā)

2、充值模版中的失敗退款等功能，提升處理效率，降低人工操作。目錄目錄i一文檔說明21.1文檔目的21.2讀者對(duì)象2二交互模式22.1 請(qǐng)求/響應(yīng)交互模式22.2. 主動(dòng)通知交互模式3三安全規(guī)范33.1 安全配置33.2 數(shù)據(jù)加密及數(shù)字簽名43.3 訪問控制43.4指令日志4四供貨接口41.1接口說明41.2接口流程41.3訂單獲取接口64.4漏單檢查接口（可選）84.5訂單充值前確認(rèn)接口104.6返回充值結(jié)果接口12五供貨商管理13六附加信息說明141.1供貨請(qǐng)求響應(yīng)返回碼信息14七開發(fā)支持14一文檔說明1.1 文檔目的歐飛sup供貨商接入系統(tǒng)，為供貨商提供了一套完善的供貨接口，為供貨商提供訂單獲

3、取與充值結(jié)果返回服務(wù)。1. 歐飛sup供貨商類型為供貨形式及采購(gòu)形式，目前只提供供貨形式的供貨商業(yè)務(wù)；2. 開放供貨接口給供貨商的同時(shí)，需要供貨商在歐飛sup供貨系統(tǒng)上開通帳戶；3. 開發(fā)接口需要供貨商在歐飛sup供貨系統(tǒng)配置接口相關(guān)參數(shù)，提供實(shí)時(shí)接口供供貨商查詢使用；4. 供貨接口包括：u 訂單獲取接口u 漏單檢查接口（可選）u 訂單充值前校驗(yàn)接口u 返回充值結(jié)果接口1.2 讀者對(duì)象本文檔閱讀對(duì)象為歐飛sup供貨商的開發(fā)技術(shù)。二交互模式2.1 請(qǐng)求/響應(yīng)交互模式請(qǐng)求/響應(yīng)模式是最常用的一種模式。在這種交互模式下，合作商系統(tǒng)向歐飛sup供貨系統(tǒng)發(fā)送請(qǐng)求數(shù)據(jù)，并同步等待歐飛sup供貨系統(tǒng)處理完畢

4、之后返回的響應(yīng)數(shù)據(jù)直至流程結(jié)束。服務(wù)請(qǐng)求是使用http協(xié)議發(fā)送給歐飛sup供貨系統(tǒng)的，請(qǐng)求數(shù)據(jù)以post形式提交。2.2. 主動(dòng)通知交互模式暫不開放。三安全規(guī)范3.1 安全配置安全配置包括以下內(nèi)容：l 簽名密鑰配置（必選）a. 請(qǐng)求簽名算法及密鑰md5b. 返回簽名算法及密鑰md5l 加密密鑰配置（可選）a. 請(qǐng)求加密算法及密鑰md5b. 返回加密算法及密鑰md5注：簽名算法和密鑰是必須的，加密算法和加密密鑰為可選（只有一些特殊接口可能必須）。3.2 數(shù)據(jù)加密及數(shù)字簽名在通訊過程中，采用rsa加密算法，歐飛sup供貨系統(tǒng)產(chǎn)生公私密鑰對(duì)，將公鑰分配給供貨商；供貨商產(chǎn)生公私密鑰對(duì)，將公鑰分配給歐飛

5、；交易過程中，對(duì)關(guān)鍵信息全文做數(shù)字摘要，再用私鑰加密；關(guān)鍵信息域全文用公鑰加密。接收?qǐng)?bào)文方對(duì)密文解密，驗(yàn)簽；而保證了數(shù)據(jù)的保密性、完整性和不可抵賴性。3.3 訪問控制歐飛sup供貨系統(tǒng)是根據(jù)請(qǐng)求參數(shù)中的供貨商id來判斷合作商的請(qǐng)求是否可以執(zhí)行。供貨商在訪問供貨接口之前，必須先開通供貨接口的訪問權(quán)限并在歐飛sup供貨系統(tǒng)生成接口密鑰。3.4指令日志歐飛sup供貨系統(tǒng)會(huì)在國(guó)家相關(guān)法律法規(guī)要求的時(shí)限內(nèi)保存合作商與歐飛之間所有完整交互指令，以方便日后為解決商業(yè)糾紛提供日志證據(jù)。合作商也應(yīng)當(dāng)按照國(guó)家相關(guān)法律法規(guī)的要求保存來自歐飛的響應(yīng)數(shù)據(jù)與主動(dòng)通知數(shù)據(jù)。四供貨接口1.1 接口說明本接口主要目的是為了讓供

6、貨商接入歐飛sup供貨系統(tǒng)，能夠在合作商系統(tǒng)中實(shí)現(xiàn)獲取訂單完成充值后將充值結(jié)果返回。 合作商系統(tǒng)作為請(qǐng)求客戶端，按照本接口的約定發(fā)送請(qǐng)求，而歐飛sup供貨系統(tǒng)監(jiān)聽來自合作商系統(tǒng)的請(qǐng)求給于處理，處理完成后將相關(guān)處理結(jié)果通知給合作商系統(tǒng)。1.2 接口流程接口流程圖： 步驟說明：1) 合作商系統(tǒng)向歐飛系統(tǒng)發(fā)起訂單獲取請(qǐng)求，歐飛系統(tǒng)將待充值的訂單返回給合作商系統(tǒng)；2) 合作商系統(tǒng)在收到待充值的訂單后發(fā)送一次確認(rèn)信息，查看是否存在漏單，歐飛系統(tǒng)核實(shí)之前發(fā)送的待充值訂單記錄，并將檢查結(jié)果返回給合作商系統(tǒng)（該步驟可選）；3) 合作商系統(tǒng)在處理單筆訂單前再次向歐飛系統(tǒng)發(fā)送充值前確認(rèn)請(qǐng)求，核實(shí)該筆訂單狀態(tài)是否有

7、變更，歐飛系統(tǒng)將確認(rèn)結(jié)果返回給合作商系統(tǒng)；4) 合作商收到確認(rèn)結(jié)果后開始處理訂單，訂單處理完成后將充值狀態(tài)返回給歐飛系統(tǒng)，歐飛系統(tǒng)將響應(yīng)的操作結(jié)果返回給合作商系統(tǒng)。如：合作商一次發(fā)起的請(qǐng)求，請(qǐng)求編號(hào)為：1234，歐飛返回的訂單，其中訂單編號(hào)為111，222，333，客戶由于外掛離線或讀取超時(shí)等原因，只收到了部分訂單（111，222）或沒有收到訂單，這時(shí)合作商通過漏單檢查接口，來驗(yàn)證該次請(qǐng)求合作商收到的訂單和歐飛返回的訂單是否一致（如，發(fā)送請(qǐng)求編號(hào)：reqid =1234，合作商收到的訂單編號(hào)orderids =111,222，如果沒收到訂單就傳orderids =），接口會(huì)返回合作商未收到的訂

8、單（訂單編號(hào)333），在合作商充值之前，通過充值前確認(rèn)接口，來確認(rèn)訂單是否可以充值（當(dāng)合作商把訂單拿走到充值這段時(shí)間內(nèi)，訂單可能會(huì)因?yàn)槟承┎豢煽匾蛩爻穯危苊鈸p失，只有歐飛明確返回了該筆訂單可以充值的時(shí)候，合作商才可以去充值，然后講充值結(jié)果通過“返回充值結(jié)果接口”將充值結(jié)果返回給歐飛，以便及時(shí)同步訂單狀態(tài)。注：凡是不通過充值前確認(rèn)接口來確認(rèn)訂單是否可以充值，導(dǎo)致的損失，歐飛不擔(dān)負(fù)任何責(zé)任1.3 訂單獲取接口描述：獲取需要充值的訂單接口接口地址： http:/localhost:8077/supply.do必選參數(shù)：字段名變量名類型說明可空合作商代碼partnerstring(32)合作商代碼

9、n模板編號(hào)tplidstring(32)模板編號(hào)n簽名signstring(32)簽名（md5加密后轉(zhuǎn)為大寫）（partner+tplid+apikey） 備注：apikey為加密密鑰n請(qǐng)求編號(hào)reqidstring請(qǐng)求編號(hào)(請(qǐng)求編號(hào)唯一)n說明：合作商代碼指供貨平臺(tái)對(duì)應(yīng)的編號(hào)，如s000000，模板編號(hào)請(qǐng)先在平臺(tái)創(chuàng)建一個(gè)自定義模板，系統(tǒng)自動(dòng)會(huì)生成一個(gè)如mb000000000的模板編號(hào)。 可選參數(shù)：字段名變量名類型說明可空返回格式formatstring(20)xml，json，string，留空默認(rèn)為xmly接口返回xml格式的節(jié)點(diǎn)元素：字段名節(jié)點(diǎn)名節(jié)點(diǎn)級(jí)別說明父節(jié)點(diǎn)必有根節(jié)點(diǎn)result1

10、唯一的根節(jié)點(diǎn)y狀態(tài)碼status20000代表成功，其他見錯(cuò)誤碼resulty狀態(tài)描述msg2如未成功操作，則為錯(cuò)誤原因resulty數(shù)據(jù)data2所有動(dòng)態(tài)數(shù)據(jù)的根節(jié)點(diǎn)resulty商品列表datalist3供貨商發(fā)布的商品集合datan請(qǐng)求編號(hào)reqid4該次請(qǐng)求編號(hào)，用于漏單檢查datalistn字段fields4返回字段列表，字段名之間用,分隔datalistn商品單項(xiàng)item4每一項(xiàng)商品datalistnitem節(jié)點(diǎn)之間返回的字段名和fields返回的字段一致，請(qǐng)根據(jù)fields返回的字段解析item節(jié)點(diǎn)中的數(shù)據(jù)示例：請(qǐng)求：http:/localhost:8077/supply.do?

11、partner=*&tplid=20021&sign=74bc2374d6b78a3e0bb0cea4bd317ed8返回?cái)?shù)據(jù)：0000數(shù)據(jù)獲取成功fec8fe4415c7e57f0f3cbb4313f9d031河北移動(dòng)充值100元1203261696648017391068*2012-03-26 16:52:2940100150278728022002120405100083id,userid,tplid,recharge_account,product_company,esale_account,esale_password,esale_paypsw,order_i

12、d,order_time,order_ip,esup_uid,product_id,product_name,order_num,product_par_value4.4漏單檢查接口（可選）描述:驗(yàn)證一次請(qǐng)求獲取的所有訂單是否有漏單接口地址：http:/localhost:8077/checkorder.do必選參數(shù)：字段名變量名類型說明可空合作商代碼partnerstring(32)合作商代碼n模板編號(hào)tplidstring(32)模板編號(hào)n簽名signstring(32)簽名（partner+tplid+reqid+apikey） 備注：apikey為加密密鑰n需要驗(yàn)證的訂單編號(hào)order

13、idsstring(32)需要驗(yàn)證的訂單編號(hào),多個(gè)訂單號(hào)之間用英文逗號(hào)隔開n請(qǐng)求編號(hào)reqidstring(32)請(qǐng)求編號(hào)n可選參數(shù)：字段名變量名類型說明可空返回格式formatstring(20)xml，json，string，留空默認(rèn)為xmly接口返回xml格式的節(jié)點(diǎn)元素：字段名節(jié)點(diǎn)名節(jié)點(diǎn)級(jí)別說明父節(jié)點(diǎn)必有根節(jié)點(diǎn)result1唯一的根節(jié)點(diǎn)y狀態(tài)碼status20000代表成功，其他見錯(cuò)誤碼resulty狀態(tài)描述msg2如未成功操作，則為錯(cuò)誤原因resulty數(shù)據(jù)data2所有動(dòng)態(tài)數(shù)據(jù)的根節(jié)點(diǎn)resulty商品列表datalist3供貨商發(fā)布的商品集合datan請(qǐng)求編號(hào)reqid4該次請(qǐng)求編

14、號(hào)，用于漏單檢查datalistn是否有漏單leakdetecting4是否有漏單:false無漏單 true有漏單datalisty字段fields4返回字段列表，字段名之間用,分隔datalisty商品單項(xiàng)item4每一項(xiàng)商品，當(dāng)leakdetecting為true時(shí)候，返回掉的訂單數(shù)據(jù)，相關(guān)字段為fields返回的字段datalistyitem節(jié)點(diǎn)之間返回的字段名和fields返回的字段一致，請(qǐng)根據(jù)fields返回的字段解析item節(jié)點(diǎn)中的數(shù)據(jù)示例：請(qǐng)求：http:/localhost:8077/checkorder.do?partner=*&tplid=20021&sign=f269c

15、4e7a4a3a702ed0f3e752101b60f&orderids=,12032616966480,12032616966777,&reqid=20405100083返回?cái)?shù)據(jù)：0000訂單驗(yàn)證結(jié)束fec8fe4415c7e57f0f3cbb4313f9d031河北移動(dòng)充值100元1203261696664117390542*2012-03-26 16:53:3640100150752010852002120405100083trueid,userid,tplid,recharge_account,product_company,esale_account,esal

16、e_password,esale_paypsw,order_id,order_time,order_ip,esup_uid,product_id,product_name,order_num,product_par_value4.5訂單充值前確認(rèn)接口描述：訂單充值前確認(rèn)該筆訂單是否可以充值接口地址:http:/localhost:8077/confirmrecharge.do必選參數(shù)：字段名變量名類型說明可空訂單編號(hào)orderidstring(32)訂單編號(hào)n小訂單編號(hào)idstring(32)小訂單編號(hào)n可選參數(shù)：字段名變量名類型說明可空返回格式formatstring(20)xml，json

17、，string，留空默認(rèn)為xmly接口返回xml格式的節(jié)點(diǎn)元素：字段名節(jié)點(diǎn)名節(jié)點(diǎn)級(jí)別說明父節(jié)點(diǎn)必有根節(jié)點(diǎn)result1唯一的根節(jié)點(diǎn)y狀態(tài)碼status20000代表成功，其他見錯(cuò)誤碼resulty狀態(tài)描述msg2如未成功操作，則為錯(cuò)誤原因resulty數(shù)據(jù)data2所有動(dòng)態(tài)數(shù)據(jù)的根節(jié)點(diǎn)resulty是否可以充值canrechaege3是否可以充值:true可以充值false不可用充值datay示例：請(qǐng)求;http:/localhost:8077/confirmrecharge.do?id=17391068&orderid=12032616966480返回?cái)?shù)據(jù)：0000數(shù)據(jù)獲取成功true4.6

18、返回充值結(jié)果接口描述：充值完成后將充值結(jié)果返回給歐飛接口地址：http:/localhost:8077/setorders.do必選參數(shù)：字段名變量名類型說明可空訂單編號(hào)orderidstring(32)訂單編號(hào)n小訂單編號(hào)idstring(32)小訂單編號(hào)n簽名signstring(32)簽名（partner+id+orderid+apikey）n訂單狀態(tài)orderstatestring(32)訂單狀態(tài)（4：充值成功 5：沖值失敗 6：可疑訂單）n合作商代碼partnerstring(32)合作商代碼n模板編號(hào)tplidstring(32)模板編號(hào)n可選參數(shù)：字段名變量名類型說明可空返回格式formatstring(20)xml，json，string，留空默認(rèn)為xml