設(shè)備維護(hù)平臺(tái)接口技術(shù)規(guī)范設(shè)計(jì)說(shuō)明書(shū)[2013_05_13]

1、<p><b>　　設(shè)備維護(hù)平臺(tái)</b></p><p><b>　　接口技術(shù)規(guī)范說(shuō)明書(shū)</b></p><p>　　（版本號(hào) V1.0）</p><p>　　杭州天夢(mèng)科技有限公司</p><p><b>　　二〇一〇年五月</b></p><p

2、><b>　　更改履歷</b></p><p>　　注：更改人除形成初稿，以后每次修改在未批準(zhǔn)確認(rèn)前均需采用修訂的方式進(jìn)行修改。</p><p>　版本號(hào)修改編號(hào)更改時(shí)間更改的圖表和章節(jié)更改簡(jiǎn)要描述更改人批準(zhǔn)人</p><p>　V1.02013-05-13創(chuàng)建，形成初稿葉慶國(guó)</p><p>　V1.12014-

3、06-09維修業(yè)務(wù)操作接口調(diào)整，僅開(kāi)放維保單位相關(guān)操作接口葉慶國(guó)</p><p><b>　　目 錄</b></p><p><b>　　1概述2</b></p><p>　　1.1編寫目的2</p><p>　　1.2預(yù)期讀者2</p><p>　　1.3參

4、考文獻(xiàn)2</p><p>　　2接口平臺(tái)設(shè)計(jì)2</p><p>　　2.1技術(shù)架構(gòu)2</p><p>　　2.1.1接口架構(gòu)圖2</p><p>　　2.1.2業(yè)務(wù)流圖3</p><p>　　2.2部署方式4</p><p>　　2.3接口標(biāo)準(zhǔn)4</p>

5、<p>　　2.3.1技術(shù)標(biāo)準(zhǔn)4</p><p>　　2.3.2數(shù)據(jù)規(guī)約5</p><p>　　2.3.3示例6</p><p>　　3Webservice服務(wù)7</p><p>　　3.1設(shè)備維護(hù)平臺(tái)提供的服務(wù)7</p><p>　　3.1.1接口服務(wù)清單7</p>&

6、lt;p>　　3.1.2接口服務(wù)設(shè)計(jì)8</p><p><b>　　概述</b></p><p><b>　　編寫目的</b></p><p>　　為設(shè)備維護(hù)平臺(tái)的信息同步和共享，制定了統(tǒng)一的接口規(guī)范，用來(lái)指導(dǎo)各系統(tǒng)的接口設(shè)計(jì)、開(kāi)發(fā)、聯(lián)調(diào)及遷移工作。</p><p>　　范圍：本文檔主要是

7、對(duì)設(shè)備維護(hù)平臺(tái)與外圍業(yè)務(wù)系統(tǒng)的數(shù)據(jù)交互需求進(jìn)行說(shuō)明。</p><p><b>　　調(diào)試要求</b></p><p>　　強(qiáng)烈要求第三方調(diào)用者，先做測(cè)試庫(kù)的接口調(diào)試，確保接口及參數(shù)調(diào)用正確，否則將對(duì)正式庫(kù)可能出現(xiàn)的系統(tǒng)故障承擔(dān)主要責(zé)任。</p><p><b>　　預(yù)期讀者</b></p><p>　

8、　項(xiàng)目組人員、各交互系統(tǒng)涉及到的開(kāi)發(fā)廠家。</p><p><b>　　參考文獻(xiàn)</b></p><p>　　《智能交通設(shè)備維護(hù)管理系統(tǒng)設(shè)備接入標(biāo)準(zhǔn)》杭州天夢(mèng)科技有限公司</p><p><b>　　接口平臺(tái)設(shè)計(jì)</b></p><p><b>　　技術(shù)架構(gòu)</b></

9、p><p><b>　　接口架構(gòu)圖</b></p><p><b>　?。〞喝保?lt;/b></p><p><b>　　業(yè)務(wù)流圖</b></p><p>　　說(shuō)明：用戶通過(guò)接口。</p><p><b>　　部署方式</b></p&

10、gt;<p>　　接口服務(wù)層包括Webservice服務(wù)、展現(xiàn)集成服務(wù)。</p><p>　　Webservice服務(wù)</p><p>　　各系統(tǒng)提供的接口服務(wù)統(tǒng)一部署在設(shè)備維護(hù)平臺(tái)接口服務(wù)層上，各系統(tǒng)客戶端和接口服務(wù)層用SOAP協(xié)議通過(guò)HTTP來(lái)交互，客戶端根據(jù)WSDL描述文檔生成SOAP請(qǐng)求消息發(fā)送到服務(wù)端，服務(wù)端解析收到的SOAP請(qǐng)求，調(diào)用Web service，然后再

11、生成相應(yīng)的SOAP應(yīng)答送回到客戶端。</p><p><b>　　展現(xiàn)集成服務(wù)</b></p><p>　　展現(xiàn)集成服務(wù)主要是應(yīng)用界面集成服務(wù)，由服務(wù)提供方提供詳細(xì)的URL及相關(guān)參數(shù)說(shuō)明，調(diào)用方傳入?yún)?shù)，調(diào)用服務(wù)方提供的頁(yè)面進(jìn)行展現(xiàn)。</p><p>　　平臺(tái)Service組件服務(wù)</p><p>　　平臺(tái)Service

12、組件服務(wù)統(tǒng)一部署在設(shè)備維護(hù)平臺(tái)接口服務(wù)層上，通過(guò)平臺(tái)接口服務(wù)層進(jìn)行查詢操作。</p><p><b>　　接口標(biāo)準(zhǔn)</b></p><p><b>　　技術(shù)標(biāo)準(zhǔn)</b></p><p><b>　　簡(jiǎn)述</b></p><p>　　客戶端和服務(wù)器用SOAP協(xié)議通過(guò)HTTP來(lái)交互

13、，客戶端根據(jù)WSDL描述文檔生成SOAP請(qǐng)求消息發(fā)送到服務(wù)端，服務(wù)端解析收到的SOAP請(qǐng)求，調(diào)用Web service，然后再生成相應(yīng)的SOAP應(yīng)答送回到客戶端。</p><p><b>　　認(rèn)證機(jī)制</b></p><p>　　設(shè)備維護(hù)平臺(tái)提供的所有WebService服務(wù)均需要認(rèn)證授權(quán)才能被調(diào)用，Webservice服務(wù)接收到請(qǐng)求后從傳入?yún)?shù)中獲取用戶名和密碼，進(jìn)

14、行認(rèn)證，認(rèn)證通過(guò)后再調(diào)用具體服務(wù)。</p><p><b>　　數(shù)據(jù)規(guī)約</b></p><p><b>　　簡(jiǎn)述</b></p><p>　　客戶端和服務(wù)端采用XML格式的字符串來(lái)交互業(yè)務(wù)數(shù)據(jù)，客戶端將業(yè)務(wù)數(shù)據(jù)組織成XML格式的字符串作為最后一個(gè)入?yún)⒄{(diào)用服務(wù)端接口，服務(wù)端解析XML格式的字符串得到業(yè)務(wù)數(shù)據(jù)處理業(yè)務(wù)并把結(jié)果

15、組織成XML格式的字符串返回給客戶端。</p><p>　　接口調(diào)用的結(jié)果，自動(dòng)序列化后，以XML格式的字符串返回，其中包含了接口調(diào)用中出現(xiàn)的錯(cuò)誤描述。 </p><p><b>　　格式約定</b></p><p>　　若是業(yè)務(wù)接口調(diào)用，將以DataItem_Rsp類實(shí)例序列化，表示單一數(shù)據(jù)項(xiàng)，內(nèi)容包括操作結(jié)果、錯(cuò)誤描述，無(wú)數(shù)據(jù)集。</

16、p><p>　　若是查詢接口調(diào)用，將以EntSetSerialize_Rsp類實(shí)例序列化，表示查詢結(jié)果，其中包括錯(cuò)誤描述，有數(shù)據(jù)集。</p><p>　　XML字符串中，若是節(jié)點(diǎn)取值為null，則是<BANK_CODE xsi:nil="true"></BANK_CODE>，在節(jié)點(diǎn)中存在屬性xsi:nil="true"；若是節(jié)點(diǎn)取

17、值為空字符串，則是<BANK_NAME/>。</p><p>　　XML編碼格式為“UTF-8”；</p><p>　　字段為日期的遵循以下約定：</p><p>　　年月日格式統(tǒng)一為“YYYY-MM-DD”，如“2006-06-22”。</p><p>　　年月格式為“YYYYMM”，如“200606”。</p>

18、<p>　　包含時(shí)間的日期格式統(tǒng)一為“YYYY-MM-DDTHH:MI:SS”，如“2006-06-22T14:00:00”。</p><p>　　如果未約定日期格式，則DATE類型的默認(rèn)為“YYYY-MM-DD”，如“2006-06-22”。</p><p><b>　　格式DTD</b></p><p><b>　　示例

19、</b></p><p>　　示例：查詢接口，包含數(shù)據(jù)集</p><p>　　示例：業(yè)務(wù)接口，只有返回標(biāo)識(shí)</p><p>　　Webservice服務(wù)</p><p>　　設(shè)備維護(hù)平臺(tái)提供的服務(wù)</p><p>　　由于各用戶單獨(dú)安裝部署，故對(duì)于WebService服務(wù)地址，另外單獨(dú)提供。</p&g

20、t;<p><b>　　接口服務(wù)清單</b></p><p><b>　　接口服務(wù)設(shè)計(jì)</b></p><p><b>　　客戶端信息驗(yàn)證</b></p><p>　　基礎(chǔ)數(shù)據(jù)，設(shè)備清單查詢</p><p>　　基礎(chǔ)數(shù)據(jù)，組織機(jī)構(gòu)及設(shè)備分組查詢</p>

21、<p>　　基礎(chǔ)數(shù)據(jù)，數(shù)據(jù)項(xiàng)查詢</p><p>　　業(yè)務(wù)流程，故障上報(bào)查詢</p><p><b>　　業(yè)務(wù)流程，故障上報(bào)</b></p><p><b>　　業(yè)務(wù)流程，報(bào)修查詢</b></p><p>　　業(yè)務(wù)流程，維修報(bào)價(jià)申請(qǐng)</p><p><b&