政務(wù)信息資源 數(shù)據(jù)交換規(guī)范

ICS35.240山DB37Governmentinformationresources—Datasharedexchangespe山東省市場監(jiān)督管理局發(fā)布IDB37/T3522—2019前言 II 12規(guī)范性引用文件 13定義和術(shù)語 14縮略語 15交換方式 25.1概述 25.2服務(wù)接口 25.3庫表交換 45.4文件交換 46交換流程 56.1總流程 56.2服務(wù)接口 66.3庫表交換 66.4文件交換 67交換安全 6附錄A（規(guī)范性附錄）接口調(diào)用返回碼定義 8附錄B（資料性附錄）服務(wù)接口描述信息填寫示例 9參考文獻(xiàn) 10DB37/T3522—2019本標(biāo)準(zhǔn)按GB/T1.1—2009給出的規(guī)則起草。本標(biāo)準(zhǔn)由山東省大數(shù)據(jù)局提出、歸口并監(jiān)督實(shí)施。本標(biāo)準(zhǔn)起草單位：山東省大數(shù)據(jù)局、山東省人民政府辦公廳、山東省計(jì)算中心（國家超級計(jì)算濟(jì)南中心）、山東省大數(shù)據(jù)中心、山東省標(biāo)準(zhǔn)化研究院。本標(biāo)準(zhǔn)主要起草人：桓德銘、李學(xué)民、王傳偉、綦琳、劉燁、趙碩、陳洪波、閆雷、逄錦山、張媛、史叢叢、黃明勝、陳玉平、李剛、柯林森、李明、趙一新、劉曉飛、李敏。1DB37/T3522—2019政務(wù)信息資源數(shù)據(jù)交換規(guī)范本標(biāo)準(zhǔn)規(guī)定了政務(wù)信息資源的交換方式、交換流程和交換安全要求。本標(biāo)準(zhǔn)適用于政務(wù)信息資源的數(shù)據(jù)交換。2規(guī)范性引用文件下列文件對于本文件的應(yīng)用是必不可少的。凡是注日期的引用文件，僅所注日期的版本適用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB/T3304—1991中國各民族名稱的羅馬字母拼寫法和代碼GB/T2261.1—2003個(gè)人基本信息分類與代碼第1部分：人的性別代碼DB37/T3520—2019政務(wù)數(shù)據(jù)資源體系總體架構(gòu)DB37/T3521.1—2019政務(wù)信息資源目錄第1部分：編碼規(guī)則3定義和術(shù)語下列定義和術(shù)語適用于本文件。3.1政務(wù)信息資源governmentaffairsinformationresources政務(wù)部門在履行職責(zé)過程中制作或獲取的，以一定形式記錄、保存的文件、資料、圖表和數(shù)據(jù)等各類信息資源，包括政務(wù)部門直接或通過第三方依法采集的、依法授權(quán)管理的和因履行職責(zé)需要依托政務(wù)信息系統(tǒng)形成的信息資源等。[DB/T3520—2019，定義3.1]3.2信息資源代碼informationresourcecode用于唯一標(biāo)識政務(wù)信息資源的一組字符。[DB/T3521.1—2019，定義3.3]3.3交換exchange信息資源提供方和信息資源需求方間通過政務(wù)信息資源共享交換平臺實(shí)現(xiàn)政務(wù)信息資源在線傳送的過程。4縮略語2DB37/T3522—2019下列縮略語適用于本文件。HTTP：超文本傳輸協(xié)議(HypertextTransferProtocal)HTTPS：安全超文本傳輸協(xié)議(SecureHypertextTransferProtocal)WSDL：Web服務(wù)描述語言(WebServicesDescriptionLanguage)SOAP：簡單對象訪問協(xié)議(SimpleObjectAccessProtocol)REST：表述性狀態(tài)傳遞(RepresentationalStateTransfer)Utf-8：Unicode的可變長度字符編碼(8-bitUnicodeTransformationFormat)5交換方式5.1概述信息資源提供方（提供方）和信息資源需求方（需求方）通過政務(wù)信息資源共享交換平臺（共享交換平臺）實(shí)現(xiàn)政務(wù)信息資源（資源）的交換。數(shù)據(jù)交換方式包括但不限于：a)服務(wù)接口方式：通過服務(wù)接口實(shí)現(xiàn)數(shù)據(jù)交換或功能調(diào)用，適用于實(shí)時(shí)性和靈活性要求較高、數(shù)據(jù)量較小的數(shù)據(jù)交換；b)庫表方式：以數(shù)據(jù)庫表結(jié)構(gòu)形式的交換方式，適用于體量大、數(shù)據(jù)增量更新頻繁的數(shù)據(jù)交換；c)文件方式：通過文件發(fā)送的方式將規(guī)范化的數(shù)據(jù)文件傳送到指定的交換節(jié)點(diǎn)，適用于非結(jié)構(gòu)化數(shù)據(jù)或更新較緩慢的結(jié)構(gòu)化數(shù)據(jù)的交換。5.2服務(wù)接口5.2.1設(shè)計(jì)原則服務(wù)接口設(shè)計(jì)的基本原則包括但不限于：a)安全性原則：應(yīng)提供多種安全可靠的技術(shù)手段，保證接口數(shù)據(jù)的安全；b)開放性原則：應(yīng)采用通用的接口設(shè)計(jì)標(biāo)準(zhǔn)，保證與其他系統(tǒng)的互聯(lián)互通；c)靈活性原則：應(yīng)能根據(jù)業(yè)務(wù)變化，靈活調(diào)整接口容量與性能；d)松耦合原則：應(yīng)避免提供方的業(yè)務(wù)系統(tǒng)對接口服務(wù)實(shí)現(xiàn)的依賴性。5.2.2基本要求接口名稱接口名稱應(yīng)采用中文名稱，由提供方名稱、信息資源名稱和接口分類三部分組成。提供方名稱宜使用國家規(guī)定的部門簡稱，如山東省公安廳簡稱為省公安廳。接口分類接口分為查詢類、驗(yàn)證類、數(shù)據(jù)傳輸類、下載類及其他類，接口分類代碼見表1。表1接口分類代碼123493DB37/T3522—2019接口代碼服務(wù)接口代碼由接口提供方代碼、政務(wù)信息資源代碼、接口分類代碼和接口順序碼四部分組成，代碼結(jié)構(gòu)見圖1。圖1服務(wù)接口代碼結(jié)構(gòu)服務(wù)接口代碼編碼規(guī)則如下：a)第1位為接口提供方代碼，使用1位大寫英文字母表示，“T”標(biāo)識資源提供方開發(fā)接口，“P”標(biāo)識共享交換平臺統(tǒng)一開發(fā)接口；b)第2～13位為政務(wù)信息資源代碼，使用12位阿拉伯?dāng)?shù)字表示，采用DB37/T3521.1—2019信息資源代碼的后12位，編碼范圍從000001000001～999999999999；c)第14位為接口分類代碼，使用1位阿拉伯?dāng)?shù)字表示，編碼范圍為1～9，分類代碼見節(jié)；d)第15～16位為接口順序碼，使用2位阿拉伯?dāng)?shù)字表示，用于標(biāo)識同一接口分類下的接口順序，編碼范圍為01～99。5.2.3技術(shù)要求服務(wù)接口技術(shù)要求包括但不限于：a)服務(wù)傳輸協(xié)議：應(yīng)符合HTTP/HTTPS1.0/1.1標(biāo)準(zhǔn)；b)服務(wù)消息協(xié)議：WebService服務(wù)消息封裝應(yīng)符合SOAP1.1/1.2標(biāo)準(zhǔn)；REST服務(wù)消息封裝應(yīng)符合HTTP1.0/1.1標(biāo)準(zhǔn)；c)服務(wù)描述要求：服務(wù)描述的內(nèi)容格式應(yīng)符合WSDL1.1、SOAP1.1/1.2標(biāo)準(zhǔn)。5.2.4開發(fā)要求服務(wù)接口包括共享交換平臺和提供方開發(fā)的接口。共享交換平臺開發(fā)的接口應(yīng)由需求方提出申請，提供方提供系統(tǒng)IP地址、用戶名、密碼、接口功能名稱等信息，并由共享交換平臺接口開發(fā)人員編寫需求文檔。服務(wù)接口開發(fā)要求包括但不限于：a)接口名稱：接口的中文名稱應(yīng)符合的規(guī)定。b)接口方式：一般包括WebService和REST兩種方式，若為REST方式，應(yīng)標(biāo)明REST操作。c)接口方法：命名應(yīng)采用大小寫混合的形式，以小寫字母開頭，名稱中其他單詞的首字母以大寫字母開頭，不宜使用下劃線分割單詞。d)接口測試：接口應(yīng)對共享交換平臺開放測試權(quán)限，并提供測試用例。e)接口授權(quán)：提供方授權(quán)的接口應(yīng)明確管控參數(shù)ApiKey。4DB37/T3522—2019f)接口參數(shù)：1)REST類型的服務(wù)接口，僅允許在Header里傳入授權(quán)驗(yàn)證相關(guān)的參數(shù)，不允許使用共享交換平臺保留的參數(shù)名AppKey、AppSecret、ApiKey、ApiSecret，POST方式的接口支持在Body中傳遞Application/JSON格式的參數(shù)；2)WebService類型的服務(wù)接口，不允許在Header傳遞參數(shù)，應(yīng)在Body中進(jìn)行傳遞；3)傳遞參數(shù)為中文字符時(shí)，應(yīng)采用Utf-8編碼。g)返回?cái)?shù)據(jù)：1)接口注冊時(shí)應(yīng)標(biāo)明接口的返回格式；2)返回?cái)?shù)據(jù)應(yīng)采用固定的格式封裝，一般為xml、JSON等；3)接口調(diào)用不通過，可通過返回碼返回?cái)?shù)據(jù)，接口調(diào)用返回碼定義見附錄A。5.2.5發(fā)布要求服務(wù)接口發(fā)布時(shí)，應(yīng)與政務(wù)信息資源目錄相對應(yīng)，并準(zhǔn)確填寫接口描述信息。接口描述信息包括但不限于接口概述、接口名稱、接口分類、接口方式、接口地址、接口授權(quán)、接口方法、輸入輸出參數(shù)，以及接口實(shí)例。接口主要描述信息填寫要求包括但不限于：a)接口概述：應(yīng)描述出接口的提供方和功能；b)接口授權(quán)：應(yīng)明確服務(wù)授權(quán)方，服務(wù)授權(quán)方包括共享交換平臺和提供方；c)輸入?yún)?shù)：針對每個(gè)接口方法，應(yīng)給出參數(shù)名、參數(shù)說明、類型、約束等輸入信息；d)輸出參數(shù)：針對每個(gè)接口方法，應(yīng)給出返回值格式等輸出信息；e)接口實(shí)例：提供方應(yīng)提供服務(wù)接口實(shí)例，并標(biāo)注返回參數(shù)含義等信息。接口描述信息填寫示例參見附錄B。5.2.6服務(wù)更新提供方若因業(yè)務(wù)變更，需對交換數(shù)據(jù)進(jìn)行變更時(shí)，應(yīng)在不影響使用的原則下對已發(fā)布的服務(wù)接口更新，接口更新時(shí)應(yīng)保留原版本。服務(wù)接口更新要求包括但不限于：a)應(yīng)提前在本級共享交換平臺進(jìn)行更新備案，說明服務(wù)更新的計(jì)劃停止時(shí)間、重新啟動(dòng)時(shí)間、變更內(nèi)容等；b)應(yīng)避免在工作時(shí)間內(nèi)進(jìn)行服務(wù)接口更新；c)應(yīng)避免變更輸入、輸出參數(shù)。5.2.7授權(quán)驗(yàn)證應(yīng)通過共享交換平臺分配的接口密鑰、訪問令牌等方式對調(diào)用服務(wù)申請進(jìn)行授權(quán)驗(yàn)證。5.3庫表交換庫表交換要求包括但不限于：a)應(yīng)按照數(shù)據(jù)交換內(nèi)容在提供方和需求方部署的前置服務(wù)器上安裝數(shù)據(jù)庫及創(chuàng)建數(shù)據(jù)庫表；b)提供方和需求方應(yīng)提前約定數(shù)據(jù)交換格式、交換頻率、交換內(nèi)容等；c)需求方在共享交換平臺填寫申請資料時(shí)應(yīng)選定數(shù)據(jù)類型；d)數(shù)據(jù)獲取后，需求方應(yīng)對獲取的入庫時(shí)間、入庫記錄數(shù)量、交換數(shù)據(jù)來源等內(nèi)容向提供方確認(rèn)。5.4文件交換文件交換方式應(yīng)將無承載系統(tǒng)的資源，通過數(shù)據(jù)錄入或數(shù)據(jù)導(dǎo)入的方式存入共享交換平臺數(shù)據(jù)庫表中，由共享交換平臺提供統(tǒng)一接口用于交換。數(shù)據(jù)錄入方式，適用于非結(jié)構(gòu)化數(shù)據(jù)和數(shù)據(jù)量較小的情況；5DB37/T3522—2019數(shù)據(jù)導(dǎo)入方式，僅適用于結(jié)構(gòu)化數(shù)據(jù)。對于非結(jié)構(gòu)化數(shù)據(jù)，無交換格式限制。對于結(jié)構(gòu)化數(shù)據(jù)，應(yīng)支持xml、xls、txt等格式文件。6交換流程6.1總流程基于共享交換平臺的資源共享交換總流程見圖2，包括但不限于：a)提供方整理可共享交換的資源，完成資源目錄的編目與報(bào)送；b)提供方在共享交換平臺完成資源發(fā)布；c)需求方通過共享交換平臺進(jìn)行檢索，對所需的資源進(jìn)行申請：1)對于無條件共享的資源，需求方在共享交換平臺備案后獲取資源；2)對于有條件共享的資源，需由提供方進(jìn)行審核，審核通過后完成資源獲取。d)提供方通過共享交換平臺以接口、庫表、文件等交換方式提供需求方所需資源；e)需求方獲取資源；f)需求方對獲取資源進(jìn)行審核：1)若提供資源與所需資源一致，需求方可直接獲取使用；2)若提供資源與所需資源不一致，需求方應(yīng)通過共享交換平臺提交糾錯(cuò)意見，并提供政務(wù)信息資源目錄、信息資源格式類型、信息資源名稱、問題描述、聯(lián)系人、聯(lián)系電話、聯(lián)系人郵箱等信息，提供方通過共享交換平臺查看糾錯(cuò)意見，并將意見反饋給需求方，需求方可重新申請資源。圖2交換總流程6DB37/T3522—20196.2服務(wù)接口服務(wù)接口交換流程包括但不限于：a)資源發(fā)布：1)提供方登錄共享交換平臺，按照服務(wù)注冊要求填報(bào)注冊信息；2)注冊完成后，共享交換平臺審核通過后發(fā)布服務(wù)接口，并實(shí)現(xiàn)代理運(yùn)行。b)接口申請：1)需求方通過共享交換平臺的服務(wù)接口列表、分類檢索和接口搜索等功能進(jìn)行服務(wù)信息的查找，獲得服務(wù)接口注冊信息；2)需求方對資源進(jìn)行申請，填寫申請部門、申請時(shí)間、調(diào)用頻率、用途說明等相關(guān)信息，獲取授權(quán)。c)接口授權(quán)：對于需求方提交的服務(wù)接口申請，提供方對其進(jìn)行授權(quán)；d)接口調(diào)用：獲得授權(quán)后，需求方使用授權(quán)碼進(jìn)行服務(wù)接口調(diào)用。6.3庫表交換庫表資源交換流程包括但不限于：a)資源發(fā)布：提供方將在準(zhǔn)備的可共享數(shù)據(jù)庫表信息加載到共享交換平臺數(shù)據(jù)表中，并登錄共享交換平臺，完成資源發(fā)布；b)資源申請與審核：1)需求方在共享交換平臺填寫相應(yīng)的申請資料，對需要的庫表資源進(jìn)行申請；2)提供方對資源申請進(jìn)行審核反饋。c)資源提供：1)補(bǔ)充配置信息：提供方和需求方在共享交換平臺，對已申請的資源補(bǔ)充配置信息，如服務(wù)器地址、數(shù)據(jù)庫類型、數(shù)據(jù)庫版本等；2)平臺配置：共享交換平臺工作人員對提供方和需求方部署的前置庫進(jìn)行聯(lián)調(diào)。d)資源獲取：需求方從共享交換平臺數(shù)據(jù)表中獲取資源。6.4文件交換文件資源交換流程包括但不限于：a)資源發(fā)布：1)交換準(zhǔn)備：提供方將準(zhǔn)備好的共享文件上傳至共享交換平臺前置節(jié)點(diǎn)；2)交換配置：提供方登錄共享交換平臺，進(jìn)行資源注冊、注冊審核、資源發(fā)布等交換配置工作。b)資源申請與審核：1)需求方通過共享交換平臺檢索目錄，對需要的文件資源進(jìn)行申請；2)提供方對資源申請進(jìn)行審核反饋。c)資源提供：提供方審核通過后，給予需求方下載權(quán)限；d)資源獲?。盒枨蠓竭M(jìn)行數(shù)據(jù)接收準(zhǔn)備工作，下載獲取資源。7交換安全政務(wù)資源交換安全要求包括但不限于：a)應(yīng)對提供方和需求方進(jìn)行身份和權(quán)限驗(yàn)證，避免非法請求；7DB37/T3522—2019b)應(yīng)實(shí)時(shí)監(jiān)控?cái)?shù)據(jù)交換通道的運(yùn)行情況，出現(xiàn)問題及時(shí)告警；c)