博云網(wǎng)SaaS產(chǎn)品ISV接口文檔

1、博云網(wǎng)SaaS產(chǎn)品ISV接入指南版本日期：20111目錄1. 文檔目的 32. 接入提交項(xiàng) 33. 接口開(kāi)發(fā)與測(cè)試環(huán)境 33.1. 接口工作流程 33.1.1. B/S 結(jié)構(gòu) 33.1.2. C/S 結(jié)構(gòu) 43.2. 接口工作內(nèi)容及步驟 53.2.1.B/S 結(jié)構(gòu) 63.2.2. C/S 結(jié)構(gòu) 63.3. 接口的定義及開(kāi)發(fā) 63.3.1.接口實(shí)現(xiàn)形式 63.3.2. 接口消息格式 63.3.3. 軟件接口定義 83.4. 配置文件說(shuō)明 103.5. 軟件試用流程 111. 文檔目的本文檔用于幫助ISV 了解其產(chǎn)品接入平臺(tái)時(shí)需要進(jìn)行哪些工作、如何進(jìn)行這些工作、完成后如何進(jìn)行測(cè)試等,ISV在開(kāi)始接

2、入工作前，請(qǐng)?jiān)敿?xì)閱讀此文檔內(nèi)容。2. 接入提交項(xiàng)提交項(xiàng)重要程度描述數(shù)據(jù)同步接口訪問(wèn)地址必需用戶購(gòu)買及添加子賬戶以及賬戶操作時(shí)同步信息的接口地址產(chǎn)品系統(tǒng)訪問(wèn)地址必需用戶使用軟件時(shí)跳轉(zhuǎn)的地址接口密鑰必需接口加密密鑰，測(cè)試環(huán)境使用默認(rèn)1234567890，上線時(shí)重新設(shè)定產(chǎn)品試用地址建議用戶試用產(chǎn)品所跳轉(zhuǎn)的地址產(chǎn)品試用賬號(hào)一般用戶試用產(chǎn)品登錄所需賬號(hào)產(chǎn)品試用密碼一般用戶試用產(chǎn)品登錄所需密碼3. 接口開(kāi)發(fā)與測(cè)試環(huán)境3.1. 接口工作流程3.1.1. B/S 結(jié)構(gòu)用戶博云網(wǎng)SaaS軟件購(gòu)買軟件調(diào)用數(shù)據(jù)同步接口發(fā)送軟件授權(quán)指令數(shù)據(jù)處理，開(kāi)通系統(tǒng)返回處理結(jié)授權(quán)使用用戶調(diào)用數(shù)據(jù)同步接口發(fā)送用戶授權(quán)指令數(shù)據(jù)處理,

3、添加用戶返回處理結(jié)（對(duì)用戶的一些操作）調(diào)用數(shù)據(jù)同步接口發(fā)送操作指令數(shù)據(jù)處理,修改用戶返回處理結(jié)用戶點(diǎn)擊使用軟件按鈕跳轉(zhuǎn)到使用軟件鑒權(quán)接進(jìn)行反向用戶鑒權(quán)調(diào)用平臺(tái)用戶鑒權(quán)接口發(fā)送鑒權(quán)指令 鑒權(quán)并返回直接進(jìn)入軟件使用返回處理結(jié)果收到結(jié)果或提示無(wú)權(quán)限使用說(shuō)明：1、用戶購(gòu)買軟件，支付完成后，我平臺(tái)調(diào)用軟件平臺(tái)的數(shù)據(jù)同步接口，發(fā)送軟件授權(quán) 指令，將用戶定制數(shù)據(jù)信息同步給軟件平臺(tái)2、購(gòu)買用戶給其它操作用戶授權(quán)，我平臺(tái)調(diào)用軟件平臺(tái)的數(shù)據(jù)同步接口，發(fā)送用戶授 權(quán)指令，將用戶授權(quán)數(shù)據(jù)信息同步給軟件平臺(tái)3、用戶使用軟件的時(shí)候，在我平臺(tái)登錄后，點(diǎn)擊軟件的使用按鈕，我平臺(tái)跳轉(zhuǎn)至軟件平臺(tái)的用戶使用鑒權(quán)地址，并將軟件及用戶

4、標(biāo)示傳遞給軟件平臺(tái)，軟件平臺(tái)根絕用戶信息，調(diào)用我平臺(tái)的用戶鑒權(quán)接口，進(jìn)行用戶身份驗(yàn)證，如果返回成功，則無(wú)需再次登錄，直接跳轉(zhuǎn)至軟件平臺(tái)內(nèi)；如果返回失敗，提示用戶無(wú)權(quán)限使用3.1.2. C/S 結(jié)構(gòu)用戶博云網(wǎng)軟件平臺(tái)服務(wù)器端軟件客戶端購(gòu)買軟件調(diào)用數(shù)據(jù)同步接口發(fā)送軟件授權(quán)指令數(shù)據(jù)處理,開(kāi)通系統(tǒng)返回處理結(jié)授權(quán)使用用戶調(diào)用數(shù)據(jù)同步接口發(fā)送冃戶授權(quán)指令數(shù)據(jù)處理,添加用戶返回處理結(jié)果（對(duì)用戶的一些操作）調(diào)用數(shù)據(jù)同步接口發(fā)送操作指令數(shù)據(jù)處理,修改用戶返回處理結(jié)果客戶端選擇博云網(wǎng)平臺(tái)使用 調(diào)用平臺(tái)用戶鑒權(quán)接口發(fā)送鑒權(quán)指令登錄軟件 鑒權(quán)并返回返回處理結(jié)果收到結(jié)果直接進(jìn)入軟件使用或提示無(wú)權(quán)限使用說(shuō)明:1、用戶購(gòu)買

5、軟件，支付完成后，我平臺(tái)調(diào)用軟件服務(wù)端平臺(tái)的數(shù)據(jù)同步接口，發(fā)送軟 件授權(quán)指令，將用戶定制數(shù)據(jù)信息同步給軟件服務(wù)端平臺(tái)2、購(gòu)買用戶給其它操作用戶授權(quán)，我平臺(tái)調(diào)用軟件服務(wù)端平臺(tái)的數(shù)據(jù)同步接口，發(fā)送用戶授權(quán)指令，將用戶授權(quán)數(shù)據(jù)信息同步給軟件服務(wù)端平臺(tái)3、用戶使用軟件的時(shí)候，在客戶端選擇所在平臺(tái)（博云網(wǎng)） ，輸入賬號(hào)登錄，軟件服 務(wù)端收到客戶端登錄請(qǐng)求，調(diào)用我平臺(tái)的用戶鑒權(quán)接口，進(jìn)行用戶身份驗(yàn)證，如果返 回成功，則直接進(jìn)入軟件平臺(tái)內(nèi)；如果返回失敗，提示用戶無(wú)權(quán)限使用。3.2. 接口工作內(nèi)容及步驟條件： 注冊(cè)成為博云網(wǎng)商家，激活賬號(hào)并發(fā)布了軟件產(chǎn)品3.2.1. B/S 結(jié)構(gòu)1、新增數(shù)據(jù)同步接口，實(shí)現(xiàn)數(shù)據(jù)

6、信息的同步接收及處理；2、去除現(xiàn)有軟件的登錄部分；3、新增軟件使用的跳轉(zhuǎn)地址，并開(kāi)發(fā)反向用戶鑒權(quán)功能。3.2.2. C/S 結(jié)構(gòu)1、服務(wù)器端新增數(shù)據(jù)同步接口，實(shí)現(xiàn)數(shù)據(jù)信息的同步接收及處理；2、修改客戶端，增加平臺(tái)選項(xiàng)，讓用戶選擇用戶來(lái)源；3、服務(wù)器端修改用戶登錄認(rèn)證，判斷如果選擇是博云網(wǎng)平臺(tái)的用戶，調(diào)用我平臺(tái)提供 的用戶鑒權(quán)接口，進(jìn)行用戶鑒權(quán)認(rèn)證。33接口的定義及開(kāi)發(fā)331.接口實(shí)現(xiàn)形式目前數(shù)據(jù)同步和用戶鑒權(quán)接口均采用Http發(fā)送Post請(qǐng)求的方式傳遞數(shù)據(jù)軟件使用采用url跳轉(zhuǎn)的方式3.3.2. 接口消息格式. 請(qǐng)求消息請(qǐng)求消息是指調(diào)用接口的一方發(fā)出的消息，.1.

7、消息頭Versio n=1& code二0&tid二1&appid二2&requesttime二3&authcode=4所有接口的請(qǐng)求消息的消息頭格式相同，具體屬性說(shuō)明見(jiàn)下表：名稱說(shuō)明數(shù)據(jù)類型長(zhǎng)度（字節(jié)）Code操作碼Stri ng4TID序列號(hào)，唯一標(biāo)識(shí)一次業(yè)務(wù)動(dòng)作Stri ngAppID業(yè)務(wù)應(yīng)用標(biāo)識(shí)（標(biāo)識(shí)是哪個(gè) ISV應(yīng)用軟件，在錄 入資源的時(shí)候由平臺(tái)統(tǒng)一分配）Stri ngRequestTime請(qǐng)求時(shí)間，14位Stri ng14Version 版本號(hào)（保留字段）當(dāng)前值 :1Stri ng校驗(yàn)碼Stri ng32AuthCodeMD5(TID+Req

8、uestTime+ISV 密碼).2. 消息體每一個(gè)接口的請(qǐng)求消息的消息體的格式各不相同，具體請(qǐng)參見(jiàn)各接口的詳細(xì)消息 格式說(shuō)明。3322 消息體加密處理消息體的原始數(shù)據(jù)為一段字符串，在消息傳輸時(shí)，消息體需要加密后傳輸，即消 息的Body部分為加密后的字符串。消息加解密調(diào)用我平臺(tái)提供的加解密接口。3323返回消息返回消息是指接口被調(diào)用的一方返回的消息。成功返回：SUCCESS失敗返回：Err :錯(cuò)誤編碼（錯(cuò)誤編碼定義如下表）錯(cuò)誤編碼定義:CodeResultCodeResultMessage描述通用1001網(wǎng)絡(luò)傳輸錯(cuò)誤Post發(fā)送或接受數(shù)據(jù)失敗1002參數(shù)不完整無(wú)參數(shù)或參數(shù)個(gè)數(shù)不對(duì)

9、1003身份不合法無(wú)法獲取接口密碼接口校驗(yàn)及加解密1011參數(shù)不正確時(shí)間格式不對(duì)1012接口已失效接口已超時(shí)1013校驗(yàn)失敗校驗(yàn)碼不止確1014加密體加密失敗1015加密體解密失敗1016參數(shù)不完整Msg參數(shù)為空無(wú)加密體定制1021Sp數(shù)據(jù)處理錯(cuò)誤授權(quán)1031Sp數(shù)據(jù)處理錯(cuò)誤鑒權(quán)1041數(shù)據(jù)內(nèi)部錯(cuò)誤1042用戶不合法333.軟件接口定義333.1. 軟件授權(quán)接口用戶購(gòu)買軟件，支付完成后，我平臺(tái)調(diào)用此接口將用戶定制數(shù)據(jù)信息同步給軟件平臺(tái)消息類型編碼1001請(qǐng)求消息消息格式Version=1 &code=0&tid=1&appid=2&requesttime=3&a

10、mp;authcode=4 &msg=加密消息體未加密的消息體格式optype=0subid=1subtype=2starttime=3en dtime=4user num=5userid=6user name=7staffname=8officeph on e=9mobileph on e=10address=11zipcode=12email=13每個(gè)參數(shù)一行，以換行符“rn ”分割，無(wú)先后順序名稱說(shuō)明數(shù)據(jù)類型長(zhǎng)度（字節(jié)）OPType受理標(biāo)志:1:開(kāi)通2:暫停3:恢復(fù)4:更新5:退訂 狀態(tài)2、3、5只用企業(yè)客戶ID和應(yīng)用（產(chǎn)品）ID字段Stri ng8SublD定制流水號(hào)Stri

11、ng50SubType定制類型（保留）默認(rèn)為 1Stri ng8StartTime開(kāi)始時(shí)間（只對(duì)OPType:1,4有效）格式為：YYYYMMDDStri ng8En dTime結(jié)束時(shí)間（只對(duì)OPType:1,4有效）Stri ng8格式為：YYYYMMDDUsernum開(kāi)通用戶數(shù)（只對(duì)OPType:1,4有效）Stri ng16Userid訂購(gòu)人idStri ngUsern ame訂購(gòu)人賬號(hào)Stri ngStaffname訂購(gòu)人姓名Stri ngOfficeph one辦公電話Stri ngMobileph one手機(jī)Stri ngAddress地址Stri ngZipcode郵編Stri

12、ngEmail郵件地址Stri ngStri ng返回消息正確返回SUCCESS錯(cuò)誤返回Err:錯(cuò)誤編碼3332用戶授權(quán)購(gòu)買用戶給其它操作用戶授權(quán)，我平臺(tái)調(diào)用此接口將用戶授權(quán)數(shù)據(jù)信息同步給軟件平 臺(tái)消息類型編碼1002請(qǐng)求消息消息格式Version=1 &code=0&tid=1&appid=2&requesttime=3&authcode=4&msg=加密消息體未加密的消息體格式optype=0 subid=1 subtype=2 starttime=3 en dtime=4 userid=5user name=6staffname=7emai

13、l=8名稱說(shuō)明數(shù)據(jù)類型長(zhǎng)度（字節(jié)）OPType操作類型：1:開(kāi)通2:暫停3:恢復(fù)4:停用Stri ng8SublD定制流水號(hào)Stri ng50SubType定制類型（保留）默認(rèn)值 1Stri ng8StartTime開(kāi)始時(shí)間（只對(duì)OPType:1,4格式為：YYYYMMDD有效）Stri ng8En dTime結(jié)束時(shí)間（只對(duì) OPType:1,4有效）Stri ng8格式為：YYYYMMDDUserid使用人idStri ngUsern ame使用人賬號(hào)Stri ngStaffname使用人姓名Stri ngEmail郵件地址Stri ng返回消息正確返回SUCCESS錯(cuò)誤返回Err:錯(cuò)誤編碼

14、3333產(chǎn)品訪問(wèn)鑒權(quán)接口用戶使用軟件的時(shí)候，軟件平臺(tái)調(diào)用此用戶鑒權(quán)接口，進(jìn)行用戶身份驗(yàn)證消息類型編碼1003請(qǐng)求消息消息格式sid=0&pid=1&uid=2&tid=3&sign=4名稱說(shuō)明數(shù)據(jù)類型長(zhǎng)度（字節(jié)）Sid應(yīng)用提供商ID （網(wǎng)站注冊(cè)時(shí)獲得）Stri ng16Pid應(yīng)用（產(chǎn)品）ID （網(wǎng)站錄入產(chǎn)品時(shí)獲得）Stri ng16Uid用戶IDStri ng36Tid提交時(shí)間（格式：yyyyMMddHHmmss）Stri ng14Sign令牌 md5(tid+spkey)Stri ng32返回消息成功返回SUCCESS userid=0 usertype=1失

15、敗返回Err:錯(cuò)誤編碼B/S模式1、用戶在我平臺(tái)點(diǎn)擊使用軟件按鈕，跳轉(zhuǎn)鏈接至產(chǎn)品使用接口地址（例如：http:/*.*.*/sp_usesoft.aspx?sid=0&pid=1&uid=2&tid=3&sig n=4）2、 產(chǎn)品使用頁(yè)面 post 數(shù)據(jù) sid=0&pid=1&uid=2&tid=3&sign=4至9/ISV_Test/ISVInterface_useauc.ashx（測(cè)試地址，正式地址在正式接入時(shí)提供）3、根據(jù)返回結(jié)果直接跳轉(zhuǎn)至軟件使用C/S模式1、 客戶端登錄時(shí)，服務(wù)器端

16、post 數(shù)據(jù) sid=0&pid=1&uid=2&tid=3&sig n=4至9/ISV_Test/ISVI nterface_useauc.ashx（測(cè)試地址，正式地址在正式接入時(shí)提供）2、根據(jù)返回結(jié)果返回給客戶端是否成功登錄3.4. 配置文件說(shuō)明"/>< add key = "saasurl "value = "9/ISV_Test/ISVInterface_useauc.ashx用戶反向鑒權(quán)接口測(cè)試地址，正式地址接入時(shí)提供< add key = " encodeurl " value = " 9/ISV_Test/isvencode.ashx"/>數(shù)據(jù)傳輸加解密測(cè)試地址，正式地址接入時(shí)提供< add key = " domain " value = " 3/net