設備維護平臺接口技術規(guī)范設計說明書[2013_05_13]

1、<p><b>　　設備維護平臺</b></p><p><b>　　接口技術規(guī)范說明書</b></p><p>　　（版本號 V1.0）</p><p>　　杭州天夢科技有限公司</p><p><b>　　二〇一〇年五月</b></p><p

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

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

4、考文獻2</p><p>　　2接口平臺設計2</p><p>　　2.1技術架構2</p><p>　　2.1.1接口架構圖2</p><p>　　2.1.2業(yè)務流圖3</p><p>　　2.2部署方式4</p><p>　　2.3接口標準4</p>

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

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

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

8、　項目組人員、各交互系統(tǒng)涉及到的開發(fā)廠家。</p><p><b>　　參考文獻</b></p><p>　　《智能交通設備維護管理系統(tǒng)設備接入標準》杭州天夢科技有限公司</p><p><b>　　接口平臺設計</b></p><p><b>　　技術架構</b></

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

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

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

12、組件服務統(tǒng)一部署在設備維護平臺接口服務層上，通過平臺接口服務層進行查詢操作。</p><p><b>　　接口標準</b></p><p><b>　　技術標準</b></p><p><b>　　簡述</b></p><p>　　客戶端和服務器用SOAP協(xié)議通過HTTP來交互

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

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

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

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

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

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

20、t;<p><b>　　接口服務清單</b></p><p><b>　　接口服務設計</b></p><p><b>　　客戶端信息驗證</b></p><p>　　基礎數(shù)據(jù)，設備清單查詢</p><p>　　基礎數(shù)據(jù)，組織機構及設備分組查詢</p>

21、<p>　　基礎數(shù)據(jù)，數(shù)據(jù)項查詢</p><p>　　業(yè)務流程，故障上報查詢</p><p><b>　　業(yè)務流程，故障上報</b></p><p><b>　　業(yè)務流程，報修查詢</b></p><p>　　業(yè)務流程，維修報價申請</p><p><b&