2020智慧監(jiān)督平臺(tái)數(shù)據(jù)接入規(guī)范

智慧監(jiān)督平臺(tái)數(shù)據(jù)接入規(guī)范目 次范圍 1規(guī)范性引用文件 1術(shù)語(yǔ)和定義 1縮略語(yǔ) 1智慧監(jiān)督平臺(tái)數(shù)據(jù)接入模型 2智慧監(jiān)督平臺(tái)數(shù)據(jù)接入技術(shù)要求 3附錄A（資料性附錄）接口請(qǐng)求格式示例 8附錄B（資料性附錄）接口響應(yīng)狀態(tài)碼 9附錄C（資料性附錄）認(rèn)證與鑒權(quán)流程示例 10參考文獻(xiàn) 13I智慧監(jiān)督平臺(tái)數(shù)據(jù)接入規(guī)范范圍本標(biāo)準(zhǔn)規(guī)定了監(jiān)察對(duì)象單位信息系統(tǒng)數(shù)據(jù)接入智慧監(jiān)督平臺(tái)的模型及技術(shù)要求。本標(biāo)準(zhǔn)適用于監(jiān)察對(duì)象單位信息系統(tǒng)與智慧監(jiān)督平臺(tái)進(jìn)行跨系統(tǒng)、跨平臺(tái)的實(shí)時(shí)數(shù)據(jù)聯(lián)通。規(guī)范性引用文件凡是不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB/T20271-2006信息系統(tǒng)通用安全技術(shù)要求GB/T21063.4-2007政務(wù)信息資源目錄體系第4部分：政務(wù)信息資源分類GB/T21063.5-2007政務(wù)信息資源目錄體系第5部分：政務(wù)信息資源標(biāo)識(shí)符編碼方案GB/T36622.2-2018智慧城市公共信息與服務(wù)支撐平臺(tái)第2部分：目錄管理與服務(wù)要GB/T4754-2017 國(guó)民經(jīng)濟(jì)行業(yè)分類SZDB/Z159.1-2015公共基礎(chǔ)信息數(shù)據(jù)元規(guī)范術(shù)語(yǔ)和定義下列術(shù)語(yǔ)和定義適用于本文件。3.1智慧監(jiān)督平臺(tái)intelligentsupervisionplatform通過(guò)新一代信息技術(shù)與監(jiān)督職能相結(jié)合所建設(shè)的具有廉政風(fēng)險(xiǎn)防控、問(wèn)題線索發(fā)現(xiàn)等功能的信息系統(tǒng)。3.2數(shù)據(jù)提供方dataprovider提供監(jiān)督數(shù)據(jù)的監(jiān)察對(duì)象單位。3.3數(shù)據(jù)獲取方datademander從數(shù)據(jù)提供方獲取監(jiān)督數(shù)據(jù)的紀(jì)檢監(jiān)察部門。3.4統(tǒng)一數(shù)據(jù)接入系統(tǒng)uniformdataaccesssystem智慧監(jiān)督平臺(tái)中實(shí)現(xiàn)數(shù)據(jù)接入過(guò)程管理的子系統(tǒng)?？s略語(yǔ)以下縮略語(yǔ)適用于本文件：1API：應(yīng)用程序編程接口（ApplicationProgrammingInterface）JSON：JavaScript對(duì)象標(biāo)記（JavaScriptObjectNotation）XML：可擴(kuò)展標(biāo)記語(yǔ)言（ExtensibleMarkupLanguage）REST：表述性狀態(tài)傳遞（RepresentationalStateTransfer）URL：統(tǒng)一資源定位符（UniformResourceLocator）HTTP：超文本傳輸協(xié)議（HyperTextTransferProtocol）HTTPS：超文本傳輸安全協(xié)議（HyperTextTransferProtocoloverSecureSocket）智慧監(jiān)督平臺(tái)數(shù)據(jù)接入模型總體模型實(shí)現(xiàn)智慧監(jiān)督平臺(tái)數(shù)據(jù)接入時(shí)，應(yīng)按本標(biāo)準(zhǔn)總體模型接入流程及相關(guān)技術(shù)要求進(jìn)行操作。智慧監(jiān)督平臺(tái)實(shí)現(xiàn)數(shù)據(jù)接入的總體模型見(jiàn)圖1方、數(shù)據(jù)獲取方兩種不同的角色，在本模型的各過(guò)程中分別描述了相應(yīng)角色的職責(zé)與分工。圖1智慧監(jiān)督平臺(tái)數(shù)據(jù)接入總體模型2數(shù)據(jù)接入過(guò)程元數(shù)據(jù)管理過(guò)程能夠快速識(shí)別字段級(jí)別的業(yè)務(wù)含義和技術(shù)含義。數(shù)據(jù)目錄管理過(guò)程由數(shù)據(jù)提供方將已進(jìn)行標(biāo)準(zhǔn)化處理的數(shù)據(jù)編制成數(shù)據(jù)目錄，并對(duì)數(shù)據(jù)目錄進(jìn)行管理。接口管理過(guò)程由數(shù)據(jù)提供方生成用于監(jiān)督的實(shí)時(shí)數(shù)據(jù)查詢的接口，并對(duì)接口進(jìn)行管理。認(rèn)證與鑒權(quán)過(guò)程由數(shù)據(jù)提供方和數(shù)據(jù)獲取方對(duì)訪問(wèn)己方系統(tǒng)的用戶進(jìn)行安全認(rèn)證和身份鑒別，確保用戶身份的合法性和用戶權(quán)限的有效性，用戶只能在已有權(quán)限范圍內(nèi)進(jìn)行操作。數(shù)據(jù)對(duì)接管理過(guò)程數(shù)據(jù)獲取方進(jìn)行數(shù)據(jù)查詢、采集。數(shù)據(jù)安全管理過(guò)程據(jù)安全。數(shù)據(jù)應(yīng)用管理過(guò)程由數(shù)據(jù)獲取方對(duì)接入數(shù)據(jù)進(jìn)行處理，使其滿足智慧監(jiān)督平臺(tái)的業(yè)務(wù)要求。智慧監(jiān)督平臺(tái)數(shù)據(jù)接入技術(shù)要求元數(shù)據(jù)管理數(shù)據(jù)提供方負(fù)責(zé)元數(shù)據(jù)的維護(hù)與管理，元數(shù)據(jù)管理要求包括且不僅限于：GB/T36622.2-20184.2的要求；統(tǒng)一數(shù)據(jù)類型和格式，具體數(shù)據(jù)類型和數(shù)據(jù)格式應(yīng)滿足SZDB/Z159.1-2015中第5c）統(tǒng)一常用數(shù)據(jù)值域，具體參照SZDB/Z159.1-2015第5章相關(guān)要求。數(shù)據(jù)目錄管理概述數(shù)據(jù)目錄管理應(yīng)由數(shù)據(jù)提供方按以下要求，建立數(shù)據(jù)目錄管理制度并管理數(shù)據(jù)目錄的生成、發(fā)布、維護(hù)和訪問(wèn)等過(guò)程。數(shù)據(jù)目錄生成31的內(nèi)容：表1數(shù)據(jù)目錄內(nèi)容編號(hào)數(shù)據(jù)項(xiàng)說(shuō)明1數(shù)據(jù)目錄編碼數(shù)據(jù)目錄的編碼2名稱數(shù)據(jù)的名稱3摘要對(duì)數(shù)據(jù)內(nèi)容的整體描述或說(shuō)明4主題分類數(shù)據(jù)所屬主題5關(guān)鍵字對(duì)數(shù)據(jù)內(nèi)容的簡(jiǎn)要概括6數(shù)據(jù)提供部門數(shù)據(jù)目錄來(lái)源部門7行業(yè)分類數(shù)據(jù)對(duì)應(yīng)的行業(yè)分類8發(fā)布時(shí)間數(shù)據(jù)目錄發(fā)布的具體時(shí)間9更新時(shí)間數(shù)據(jù)目錄更新的具體時(shí)間10更新頻率數(shù)據(jù)目錄更新頻率，如年、月、周、日等11所屬行政區(qū)域生成數(shù)據(jù)目錄的部門所屬行政區(qū)域12支持格式數(shù)據(jù)格式，如CSV、XLS（或XLSX）、JSON等格式13資源狀態(tài)數(shù)據(jù)目錄的狀態(tài)，如激活、廢棄等14記錄數(shù)量目錄中數(shù)據(jù)的數(shù)量15來(lái)源系統(tǒng)數(shù)據(jù)庫(kù)系統(tǒng)來(lái)源16時(shí)間范圍數(shù)據(jù)內(nèi)容屬于的時(shí)間范圍17接入方式接入數(shù)據(jù)的方式GB/T21063.5-2007GB/T21063.4-2007GB/T4754-2017對(duì)于結(jié)構(gòu)化數(shù)據(jù)，應(yīng)提供完整的數(shù)據(jù)目錄；數(shù)據(jù)目錄發(fā)布據(jù)獲取方應(yīng)被納入在內(nèi)，并且具有讀取全局?jǐn)?shù)據(jù)的權(quán)限。數(shù)據(jù)目錄發(fā)布的要求包括且不限于：應(yīng)包括數(shù)據(jù)目錄內(nèi)容說(shuō)明；應(yīng)保證數(shù)據(jù)目錄的完整性和時(shí)效性。數(shù)據(jù)目錄維護(hù)不限于：數(shù)據(jù)目錄變更管理流程應(yīng)包括變更申請(qǐng)、變更審批、變更實(shí)施、變更記錄等過(guò)程；取方進(jìn)行審核。數(shù)據(jù)目錄訪問(wèn)4數(shù)據(jù)提供方應(yīng)為數(shù)據(jù)獲取方提供具有訪問(wèn)全局?jǐn)?shù)據(jù)權(quán)限的賬號(hào)，以支持?jǐn)?shù)據(jù)獲取方讀取對(duì)應(yīng)的數(shù)據(jù)資源。接口管理概述程。接口設(shè)計(jì)接口設(shè)計(jì)要求包括且不限于：接口命名應(yīng)符合統(tǒng)一的編程語(yǔ)言規(guī)范，并且采用統(tǒng)一的命名風(fēng)格；JSONXMLRESTA；RFC2616B；接口響應(yīng)消息應(yīng)采用固定格式進(jìn)行封裝，每條響應(yīng)消息應(yīng)包括：狀態(tài)碼（code）、消息內(nèi)容（creator）（remark）等；UTF-8接口發(fā)布接口生成后，數(shù)據(jù)提供方應(yīng)及時(shí)通過(guò)統(tǒng)一數(shù)據(jù)接入系統(tǒng)向數(shù)據(jù)獲取方發(fā)布接口信息；接口發(fā)布內(nèi)容應(yīng)包括且不限于以下信息：——接口說(shuō)明；——狀態(tài)碼參照表；——接口調(diào)用示例文檔。數(shù)據(jù)提供方應(yīng)對(duì)數(shù)據(jù)接口進(jìn)行維護(hù)，對(duì)接口變更流程進(jìn)行統(tǒng)一管理。接口維護(hù)要求包括且不限于：APIURL，多版本并存，采用增量的方式發(fā)布；接口信息同步機(jī)制，接口的變更應(yīng)及時(shí)更新到統(tǒng)一數(shù)據(jù)接入系統(tǒng)，并由數(shù)據(jù)獲取方進(jìn)行審核。接口訪問(wèn)數(shù)據(jù)獲取方訪問(wèn)數(shù)據(jù)提供方數(shù)據(jù)的接口，具備讀取數(shù)據(jù)操作權(quán)限；持?jǐn)?shù)據(jù)獲取方通過(guò)接口對(duì)數(shù)據(jù)的實(shí)時(shí)調(diào)用。認(rèn)證與鑒權(quán)概述為保證數(shù)據(jù)的安全，數(shù)據(jù)的發(fā)布和調(diào)用應(yīng)經(jīng)過(guò)認(rèn)證與鑒權(quán)。數(shù)據(jù)發(fā)布的認(rèn)證與鑒權(quán)5在數(shù)據(jù)發(fā)布過(guò)程中：限；數(shù)據(jù)獲取方應(yīng)對(duì)數(shù)據(jù)提供方在統(tǒng)一數(shù)據(jù)接入系統(tǒng)中的身份進(jìn)行認(rèn)證，并對(duì)其操作進(jìn)行鑒權(quán)。數(shù)據(jù)調(diào)用的認(rèn)證與鑒權(quán)在數(shù)據(jù)調(diào)用的過(guò)程中：限的有效性；數(shù)據(jù)提供方應(yīng)對(duì)數(shù)據(jù)獲取方調(diào)用數(shù)據(jù)過(guò)程中的身份進(jìn)行認(rèn)證，并對(duì)其操作進(jìn)行鑒權(quán)；C。數(shù)據(jù)對(duì)接管理概述數(shù)據(jù)對(duì)接過(guò)程基于統(tǒng)一數(shù)據(jù)接入系統(tǒng)進(jìn)行，數(shù)據(jù)提供方在統(tǒng)一數(shù)據(jù)接入系統(tǒng)上發(fā)布并維護(hù)數(shù)據(jù)目錄及接口等信息；數(shù)據(jù)獲取方基于統(tǒng)一數(shù)據(jù)接入系統(tǒng)上的數(shù)據(jù)目錄和接口等信息，訪問(wèn)并調(diào)用數(shù)據(jù)資源。統(tǒng)一數(shù)據(jù)接入系統(tǒng)功能要求統(tǒng)一數(shù)據(jù)接入系統(tǒng)功能應(yīng)包括且不限于：用戶管理，包括用戶注冊(cè)、登錄、注銷等功能；權(quán)限管理，實(shí)現(xiàn)對(duì)用戶權(quán)限的統(tǒng)一管理；數(shù)據(jù)目錄管理，實(shí)現(xiàn)對(duì)數(shù)據(jù)目錄發(fā)布、數(shù)據(jù)目錄維護(hù)和數(shù)據(jù)目錄訪問(wèn)等過(guò)程的管理；數(shù)據(jù)接口管理，實(shí)現(xiàn)對(duì)接口發(fā)布、接口維護(hù)和接口訪問(wèn)等過(guò)程的管理；數(shù)據(jù)預(yù)覽，用戶可通過(guò)在線預(yù)覽方式迅速獲取部分?jǐn)?shù)據(jù)快照信息；系統(tǒng)審計(jì)，實(shí)現(xiàn)對(duì)用戶在統(tǒng)一數(shù)據(jù)接入系統(tǒng)操作的監(jiān)控。統(tǒng)一數(shù)據(jù)接入系統(tǒng)對(duì)接流程統(tǒng)一數(shù)據(jù)對(duì)接流程包括：到統(tǒng)一數(shù)據(jù)接入系統(tǒng)；才能正常發(fā)布；6.16.3據(jù)。數(shù)據(jù)安全管理概述據(jù)傳輸安全、數(shù)據(jù)防篡改等。數(shù)據(jù)存儲(chǔ)安全6數(shù)據(jù)提供方與數(shù)據(jù)獲取方對(duì)數(shù)據(jù)存儲(chǔ)安全應(yīng)從物理安全、運(yùn)行安全、數(shù)據(jù)安全等多方面進(jìn)行考慮，具體可參考GB/T20271-2006相關(guān)規(guī)定。數(shù)據(jù)傳輸安全數(shù)據(jù)獲取方與數(shù)據(jù)提供方在數(shù)據(jù)交互過(guò)程中，要求采用HTTPS協(xié)議，或者其他具有同等或者更高安全級(jí)別的傳輸協(xié)議。數(shù)據(jù)防篡改數(shù)據(jù)提供方與數(shù)據(jù)獲取方應(yīng)加強(qiáng)數(shù)據(jù)安全保障體系建設(shè)，防止數(shù)據(jù)造假、篡改、竊取等事件發(fā)生。數(shù)據(jù)應(yīng)用管理保證數(shù)據(jù)完整性，數(shù)據(jù)獲取方可定期對(duì)數(shù)據(jù)進(jìn)行檢查。7附錄A（資料性附錄）表A.1給出了接口請(qǐng)求格式示例。表A.1接口請(qǐng)求格式示例請(qǐng)求URLhttps://ip:port/api/v{n}/resource?access_token=ACCESS_TOKEN請(qǐng)求方法POST/GET請(qǐng)求參數(shù)是否必傳數(shù)據(jù)類型說(shuō)明page否int頁(yè)碼size否char(n)分頁(yè)大小***否根據(jù)具體情況確定業(yè)務(wù)參數(shù)返回參數(shù)參數(shù)名是否必傳數(shù)據(jù)類型說(shuō)明code是int狀態(tài)碼(200表示請(qǐng)求正常，其它值異常)message否char(n)消息提示，n為消息長(zhǎng)度，其取值根據(jù)具體情況確定data否根據(jù)具體情況確定接口的主數(shù)據(jù)，即業(yè)務(wù)數(shù)據(jù)?？梢愿鶕?jù)實(shí)際返回?cái)?shù)組或者特定格式數(shù)據(jù)對(duì)象（如JSON格式、XML格式等）total否int記錄總數(shù)，列表查詢返回page否int當(dāng)前頁(yè)，列表查詢返回size否int分頁(yè)大小，列表查詢返回pages否int總頁(yè)數(shù)，列表查詢返回8附錄B（資料性附錄）接口響應(yīng)狀態(tài)碼B.1接口返回狀態(tài)碼狀態(tài)碼的定義遵循RFC2616規(guī)范，常見(jiàn)HTTP響應(yīng)狀態(tài)碼及其含義如表B.1：表B.1接口返回狀態(tài)碼狀態(tài)碼含義200請(qǐng)求已成功400請(qǐng)求信息不完整或無(wú)法解析401訪問(wèn)令牌沒(méi)有提供，或者無(wú)效403訪問(wèn)令牌有效，但沒(méi)有權(quán)限404資源不存在409資源沖突422請(qǐng)求信息完整，但無(wú)效500服務(wù)器內(nèi)部拋出錯(cuò)誤9附錄C（資料性附錄）身份認(rèn)證數(shù)據(jù)獲取方根據(jù)已有賬號(hào)信息創(chuàng)建安全會(huì)話并獲取access_token（訪問(wèn)令牌）。請(qǐng)求示例：POST請(qǐng)求：https://ip:port/api/v{n}/auth/loginContent-Type:application/json請(qǐng)求參數(shù)：{"app_key":"APP_KEY","app_secret":"APP_SECRET"}返回結(jié)果：{"code":200,"message":"success","access_token":"91440300792588888K","expires_in":"86400"}訪問(wèn)控制數(shù)據(jù)獲取方根據(jù)獲取到的access_token調(diào)用接口。請(qǐng)求示例：GET請(qǐng)求：https://ip:port/api/v{n}/resource/get_data?access_token=ACCESS_TOKEN返回結(jié)果：正常返回結(jié)果：{"code":200,"message":"success","data":[{"user_id":"1"10"creator":AAA

"age":25"user_name":張三"create_time":2019-03-0116:00:00"updater":null"update_time":null"remark":null}{"creator":AAA

"user_id":"2""age":32"user_name":李四"create_time":2019-03-0116:00:00"updater":null"update_time":null"remark":null}{"creator":AAA

"user_id":"3""age":22"user_name":王五"create_time":2019-03-0116:00:00"updater":null"update_time":null"remark":null}],"total":5,"page_nam