DB4403-T 37-2019 智慧監(jiān)督平臺數(shù)據(jù)接入規(guī)范

ICS35.100.01

L79

DB4403

深圳市地方標準

DB4403/T37—2019

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

Dataaccessspecificationsforintelligentsupervisionplatform

2019-12-25發(fā)布2020-02-01實施

深圳市市場監(jiān)督管理局發(fā)布

DB4403/T37-2019

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

1范圍

本標準規(guī)定了監(jiān)察對象單位信息系統(tǒng)數(shù)據(jù)接入智慧監(jiān)督平臺的模型及技術要求。

本標準適用于監(jiān)察對象單位信息系統(tǒng)與智慧監(jiān)督平臺進行跨系統(tǒng)、跨平臺的實時數(shù)據(jù)聯(lián)通。

2規(guī)范性引用文件

下列文件對于本文件的應用是必不可少的。凡是注日期的引用文件，僅注日期的版本適用于本文件。

凡是不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。

GB/T20271-2006信息系統(tǒng)通用安全技術要求

GB/T21063.4-2007政務信息資源目錄體系第4部分：政務信息資源分類

GB/T21063.5-2007政務信息資源目錄體系第5部分：政務信息資源標識符編碼方案

GB/T36622.2-2018智慧城市公共信息與服務支撐平臺第2部分：目錄管理與服務要求

GB/T4754-2017國民經(jīng)濟行業(yè)分類

SZDB/Z159.1-2015公共基礎信息數(shù)據(jù)元規(guī)范

3術語和定義

下列術語和定義適用于本文件。

3.1

智慧監(jiān)督平臺intelligentsupervisionplatform

通過新一代信息技術與監(jiān)督職能相結合所建設的具有廉政風險防控、問題線索發(fā)現(xiàn)等功能的信息

系統(tǒng)。

3.2

數(shù)據(jù)提供方dataprovider

提供監(jiān)督數(shù)據(jù)的監(jiān)察對象單位。

3.3

數(shù)據(jù)獲取方datademander

從數(shù)據(jù)提供方獲取監(jiān)督數(shù)據(jù)的紀檢監(jiān)察部門。

3.4

統(tǒng)一數(shù)據(jù)接入系統(tǒng)uniformdataaccesssystem

智慧監(jiān)督平臺中實現(xiàn)數(shù)據(jù)接入過程管理的子系統(tǒng)。

4縮略語

以下縮略語適用于本文件：

1

DB4403/T37-2019

API：應用程序編程接口（ApplicationProgrammingInterface）

JSON：JavaScript對象標記（JavaScriptObjectNotation）

XML：可擴展標記語言（ExtensibleMarkupLanguage）

REST：表述性狀態(tài)傳遞（RepresentationalStateTransfer）

URL：統(tǒng)一資源定位符（UniformResourceLocator）

HTTP：超文本傳輸協(xié)議（HyperTextTransferProtocol）

HTTPS：超文本傳輸安全協(xié)議（HyperTextTransferProtocoloverSecureSocket）

5智慧監(jiān)督平臺數(shù)據(jù)接入模型

5.1總體模型

實現(xiàn)智慧監(jiān)督平臺數(shù)據(jù)接入時，應按本標準總體模型接入流程及相關技術要求進行操作。

智慧監(jiān)督平臺實現(xiàn)數(shù)據(jù)接入的總體模型見圖1，由元數(shù)據(jù)管理、數(shù)據(jù)目錄管理、接口管理、認證與

鑒權、數(shù)據(jù)對接管理、數(shù)據(jù)安全管理及數(shù)據(jù)應用管理等過程組成。數(shù)據(jù)接入流程參與對象分為數(shù)據(jù)提供

方、數(shù)據(jù)獲取方兩種不同的角色，在本模型的各過程中分別描述了相應角色的職責與分工。

圖1智慧監(jiān)督平臺數(shù)據(jù)接入總體模型

2

DB4403/T37-2019

5.2數(shù)據(jù)接入過程

5.2.1元數(shù)據(jù)管理過程

由數(shù)據(jù)提供方對自有的數(shù)據(jù)進行規(guī)范化和標準化管理，實現(xiàn)對數(shù)據(jù)進行準確描述，確保數(shù)據(jù)獲取方

能夠快速識別字段級別的業(yè)務含義和技術含義。

5.2.2數(shù)據(jù)目錄管理過程

由數(shù)據(jù)提供方將已進行標準化處理的數(shù)據(jù)編制成數(shù)據(jù)目錄，并對數(shù)據(jù)目錄進行管理。

5.2.3接口管理過程

由數(shù)據(jù)提供方生成用于監(jiān)督的實時數(shù)據(jù)查詢的接口，并對接口進行管理。

5.2.4認證與鑒權過程

由數(shù)據(jù)提供方和數(shù)據(jù)獲取方對訪問己方系統(tǒng)的用戶進行安全認證和身份鑒別，確保用戶身份的合

法性和用戶權限的有效性，用戶只能在已有權限范圍內進行操作。

5.2.5數(shù)據(jù)對接管理過程

由數(shù)據(jù)獲取方提供統(tǒng)一數(shù)據(jù)接入系統(tǒng)，數(shù)據(jù)提供方在統(tǒng)一數(shù)據(jù)接入系統(tǒng)發(fā)布數(shù)據(jù)目錄及接口，以供

數(shù)據(jù)獲取方進行數(shù)據(jù)查詢、采集。

5.2.6數(shù)據(jù)安全管理過程

由數(shù)據(jù)提供方與數(shù)據(jù)獲取方在數(shù)據(jù)產(chǎn)生、存儲、傳輸、應用過程中，對數(shù)據(jù)制定安全策略，保障數(shù)

據(jù)安全。

5.2.7數(shù)據(jù)應用管理過程

由數(shù)據(jù)獲取方對接入數(shù)據(jù)進行處理，使其滿足智慧監(jiān)督平臺的業(yè)務要求。

6智慧監(jiān)督平臺數(shù)據(jù)接入技術要求

6.1元數(shù)據(jù)管理

數(shù)據(jù)提供方負責元數(shù)據(jù)的維護與管理，元數(shù)據(jù)管理要求包括且不僅限于：

a）統(tǒng)一元數(shù)據(jù)管理過程，保證元數(shù)據(jù)完整性和實效性，元數(shù)據(jù)管理過程符合GB/T36622.2-2018中

4.2的要求；

b）統(tǒng)一數(shù)據(jù)類型和格式，具體數(shù)據(jù)類型和數(shù)據(jù)格式應滿足SZDB/Z159.1-2015中第5章要求；

c）統(tǒng)一常用數(shù)據(jù)值域，具體參照SZDB/Z159.1-2015第5章相關要求。

6.2數(shù)據(jù)目錄管理

6.2.1概述

數(shù)據(jù)目錄管理應由數(shù)據(jù)提供方按以下要求，建立數(shù)據(jù)目錄管理制度并管理數(shù)據(jù)目錄的生成、發(fā)布、

維護和訪問等過程。

6.2.2數(shù)據(jù)目錄生成

3

DB4403/T37-2019

a)數(shù)據(jù)目錄的內容，包括且不限于表1的內容：

表1數(shù)據(jù)目錄內容

編號數(shù)據(jù)項說明

1數(shù)據(jù)目錄編碼數(shù)據(jù)目錄的編碼

2名稱數(shù)據(jù)的名稱

3摘要對數(shù)據(jù)內容的整體描述或說明

4主題分類數(shù)據(jù)所屬主題

5關鍵字對數(shù)據(jù)內容的簡要概括

6數(shù)據(jù)提供部門數(shù)據(jù)目錄來源部門

7行業(yè)分類數(shù)據(jù)對應的行業(yè)分類

8發(fā)布時間數(shù)據(jù)目錄發(fā)布的具體時間

9更新時間數(shù)據(jù)目錄更新的具體時間

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來源系統(tǒng)數(shù)據(jù)庫系統(tǒng)來源

16時間范圍數(shù)據(jù)內容屬于的時間范圍

17接入方式接入數(shù)據(jù)的方式

b)數(shù)據(jù)目錄編碼方式應符合GB/T21063.5-2007的規(guī)定；

c)數(shù)據(jù)目錄主題分類應符合GB/T21063.4-2007的規(guī)定；

d)數(shù)據(jù)目錄行業(yè)分類應符合GB/T4754-2017的規(guī)定；

e)對于結構化數(shù)據(jù)，應提供完整的數(shù)據(jù)目錄；

f)對于非結構化數(shù)據(jù)，應先從中抽取出主要特征存儲到結構化關系表中，再生成相應的數(shù)據(jù)目錄。

6.2.3數(shù)據(jù)目錄發(fā)布

數(shù)據(jù)提供方應負責發(fā)布數(shù)據(jù)目錄信息，發(fā)布時應指定允許訪問數(shù)據(jù)目錄的用戶列表及訪問權限，數(shù)

據(jù)獲取方應被納入在內，并且具有讀取全局數(shù)據(jù)的權限。數(shù)據(jù)目錄發(fā)布的要求包括且不限于：

a)應包括數(shù)據(jù)目錄內容說明；

b)應保證數(shù)據(jù)目錄的完整性和時效性。

6.2.4數(shù)據(jù)目錄維護

數(shù)據(jù)提供方應對數(shù)據(jù)目錄進行維護，對數(shù)據(jù)目錄變更流程進行統(tǒng)一管理。數(shù)據(jù)目錄維護要求包括且

不限于：

a)數(shù)據(jù)目錄變更管理流程應包括變更申請、變更審批、變更實施、變更記錄等過程；

b)應建立數(shù)據(jù)目錄信息同步機制，數(shù)據(jù)目錄變更后應及時更新至統(tǒng)一數(shù)據(jù)接入系統(tǒng)，并由數(shù)據(jù)獲

取方進行審核。

6.2.5數(shù)據(jù)目錄訪問

4

DB4403/T37-2019

數(shù)據(jù)提供方應為數(shù)據(jù)獲取方提供具有訪問全局數(shù)據(jù)權限的賬號，以支持數(shù)據(jù)獲取方讀取對應的數(shù)

據(jù)資源。

6.3接口管理

6.3.1概述

數(shù)據(jù)提供方應向數(shù)據(jù)獲取方提供數(shù)據(jù)資源訪問接口，并提供接口描述及調用方法。數(shù)據(jù)提供方對接

口的設計和實現(xiàn)應遵循統(tǒng)一的技術規(guī)范要求，具體涉及接口設計、接口發(fā)布、接口維護和接口訪問等過

程。

6.3.2接口設計

接口設計要求包括且不限于：

a)接口命名應符合統(tǒng)一的編程語言規(guī)范，并且采用統(tǒng)一的命名風格；

b)接口請求格式應根據(jù)接口格式設定，常用格式包括且不限于JSON、XML、REST等。具體接口請

求格式示例參見附錄A；

c)接口響應時應返回相應的狀態(tài)碼，具體狀態(tài)碼應遵循RFC2616規(guī)范，參見附錄B；

d)接口響應消息應采用固定格式進行封裝，每條響應消息應包括：狀態(tài)碼（code）、消息內容

（message）、數(shù)據(jù)內容（data）等。數(shù)據(jù)內容應包括審計字段，如創(chuàng)建人（creator）、創(chuàng)建

時間（create_time）、更新人（update_person）、更新時間（update_time）、備注說明（remark）

等；

e)接口編碼方式統(tǒng)一采用UTF-8編碼。

6.3.3接口發(fā)布

a)接口生成后，數(shù)據(jù)提供方應及時通過統(tǒng)一數(shù)據(jù)接入系統(tǒng)向數(shù)據(jù)獲取方發(fā)布接口信息；

b)接口發(fā)布內容應包括且不限于以下信息：

——接口說明；

——狀態(tài)碼參照表；

——接口調用示例文檔。

6.3.4接口維護

數(shù)據(jù)提供方應對數(shù)據(jù)接口進行維護，對接口變更流程進行統(tǒng)一管理。接口維護要求包括且不限于：

a)接口版本管理機制，將API版本號放入URL，多版本并存，采用增量的方式發(fā)布；

b)接口信息同步機制，接口的變更應及時更新到統(tǒng)一數(shù)據(jù)接入系統(tǒng)，并由數(shù)據(jù)獲取方進行審核。

6.3.5接口訪問

a)數(shù)據(jù)獲取方訪問數(shù)據(jù)提供方數(shù)據(jù)的接口，具備讀取數(shù)據(jù)操作權限；

b)數(shù)據(jù)提供方在進行信息系統(tǒng)建設時，應考慮滿足數(shù)據(jù)獲取方通過接口批量獲取數(shù)據(jù)的需求，支

持數(shù)據(jù)獲取方通過接口對數(shù)據(jù)的實時調用。

6.4認證與鑒權

6.4.1概述

為保證數(shù)據(jù)的安全，數(shù)據(jù)的發(fā)布和調用應經(jīng)過認證與鑒權。

6.4.2數(shù)據(jù)發(fā)布的認證與鑒權

5

DB4403/T37-2019

在數(shù)據(jù)發(fā)布過程中：

a)數(shù)據(jù)提供方初次訪問統(tǒng)一數(shù)據(jù)接入系統(tǒng)時應進行注冊，并由數(shù)據(jù)獲取方進行審核、授予相應權

限；

b)數(shù)據(jù)獲取方應對數(shù)據(jù)提供方在統(tǒng)一數(shù)據(jù)接入系統(tǒng)中的身份進行認證，并對其操作進行鑒權。

6.4.3數(shù)據(jù)調用的認證與鑒權

在數(shù)據(jù)調用的過程中：

a)數(shù)據(jù)提供方應為數(shù)據(jù)獲取方提供可實時獲取全局數(shù)據(jù)權限的賬號信息，并保證賬號信息及其權

限的有效性；

b)數(shù)據(jù)提供方應對數(shù)據(jù)獲取方調用數(shù)據(jù)過程中的身份進行認證，并對其操作進行鑒權；

c)相關認證與鑒權流程參見附錄C。

6.5數(shù)據(jù)對接管理

6.5.1概述

數(shù)據(jù)對接過程基于統(tǒng)一數(shù)據(jù)接入系統(tǒng)進行，數(shù)據(jù)提供方在統(tǒng)一數(shù)據(jù)接入系統(tǒng)上發(fā)布并維護數(shù)據(jù)目

錄及接口等信息；數(shù)據(jù)獲取方基于統(tǒng)一數(shù)據(jù)接入系統(tǒng)上的數(shù)據(jù)目錄和接口等信息，訪問并調用數(shù)據(jù)資源。

6.5.2統(tǒng)一數(shù)據(jù)接入系統(tǒng)功能要求

統(tǒng)一數(shù)據(jù)接入系統(tǒng)功能應包括且不限于：

a)用戶管理，包括用戶注冊、登錄、注銷等功能；

b)權限管理，實現(xiàn)對用戶權限的統(tǒng)一管理；

c)數(shù)據(jù)目錄管理，實現(xiàn)對數(shù)據(jù)目錄發(fā)布、數(shù)據(jù)目錄維護和數(shù)據(jù)目錄訪問等過程的管理；

d)數(shù)據(jù)接口管理，實現(xiàn)對接口發(fā)布、接口維護和接口訪問等過程的管理；

e)數(shù)據(jù)預覽，用戶可通過在線預覽方式迅速獲取部分數(shù)據(jù)快照信息；

f)系統(tǒng)審計，實現(xiàn)對用戶在統(tǒng)一數(shù)據(jù)接入系統(tǒng)操作的監(jiān)控。

6.5.3統(tǒng)一數(shù)據(jù)接入系統(tǒng)對接流程

統(tǒng)一數(shù)據(jù)對接流程包括：

a)注冊：數(shù)據(jù)提供方通過已有賬號和密碼登錄統(tǒng)一數(shù)據(jù)接入系統(tǒng)，將數(shù)據(jù)目錄、接口等信息注冊

到統(tǒng)一數(shù)據(jù)接入系統(tǒng)；

b)審核：數(shù)據(jù)獲取方對數(shù)據(jù)提供方發(fā)布的數(shù)據(jù)目錄、接口等信息進行審核，只有審核通過的信息

才能正常發(fā)布；

c)發(fā)布：數(shù)據(jù)提供方在統(tǒng)一數(shù)據(jù)接入系統(tǒng)上發(fā)布數(shù)據(jù)目錄、接口等信息，應符合本標準6.1、6.2

及6.3的要求；

d)調用：數(shù)據(jù)獲取方根據(jù)數(shù)據(jù)提供方在統(tǒng)一數(shù)據(jù)接入系統(tǒng)上提供的數(shù)據(jù)目錄、接口等信息調用數(shù)

據(jù)。

6.6數(shù)據(jù)安全管理

6.6.1概述

數(shù)據(jù)安全管理體系是支持數(shù)據(jù)產(chǎn)生、存儲、傳輸、應用等過程的基礎，主要分為數(shù)據(jù)存儲安全、數(shù)

據(jù)傳輸安全、數(shù)據(jù)防篡改等。

6.6.2數(shù)據(jù)存儲安全

6

DB4403/T37-2019

數(shù)據(jù)提供方與數(shù)據(jù)獲取方對數(shù)據(jù)存儲安全應從物理安全、運行安全、數(shù)據(jù)安全等多方面進行考慮，

具體可參考GB/T20271-2006相關規(guī)定。

6.6.3數(shù)據(jù)傳輸安全

數(shù)據(jù)獲取方與數(shù)據(jù)提供方在數(shù)據(jù)交互過程中，要求采用HTTPS協(xié)議，或者其他具有同等或者更高安

全級別的傳輸協(xié)議。

6.6.4數(shù)據(jù)防篡改

數(shù)據(jù)提供方與數(shù)據(jù)獲取方應加強數(shù)據(jù)安全保障體系建設，防止數(shù)據(jù)造假、篡改、竊取等事件發(fā)生。

6.7數(shù)據(jù)應用管理

數(shù)據(jù)獲取方在獲取數(shù)據(jù)后，應在規(guī)定范圍內使用數(shù)據(jù)，安全地保存數(shù)據(jù)，防止數(shù)據(jù)泄露和濫用。為

保證數(shù)據(jù)完整性，數(shù)據(jù)獲取方可定期對數(shù)據(jù)進行檢查。

7

DB4403/T37-2019AA

附錄A

（資料性附錄）

接口請求格式示例

表A.1給出了接口請求格式示例。

表A.1接口請求格式示例

請求URLhttps://ip:port/api/v{n}/resource?access_token=ACCESS_TOKEN

請求方法POST/GET

請求參數(shù)是否必傳數(shù)據(jù)類型說明

page否int頁碼

size否char(n)分頁大小

***否根據(jù)具體情況確定業(yè)務參數(shù)

返回參數(shù)

參數(shù)名是否必傳數(shù)據(jù)類型說明

code是int狀態(tài)碼(200表示請求正常，其它值異常)

message否char(n)消息提示，n為消息長度，其取值根據(jù)具體情況確定

接口的主數(shù)據(jù)，即業(yè)務數(shù)據(jù)。可以根據(jù)實際返回數(shù)組或者特定格

data否根據(jù)具體情況確定

式數(shù)據(jù)對象（如JSON格式、XML格式等）

total否int記錄總數(shù)，列表查詢返回

page否int當前頁，列表查詢返回

size否int分頁大小，列表查詢返回

pages否int總頁數(shù)，列表查詢返回

8

BDB4403/T37-2019

附錄B

（資料性附錄）

接口響應狀態(tài)碼

B.1接口返回狀態(tài)碼

狀態(tài)碼的定義遵循RFC2616規(guī)范，常見HTTP響應狀態(tài)碼及其含義如表B.1：

表B.1接口返回狀態(tài)碼

狀態(tài)碼含義

200請求已成功

400請求信息不完整或無法解析

401訪問令牌沒有提供，或者無效

403訪問令牌有效，但沒有權限

404資源不存在

409資源沖突

422請求信息完整，但無效

500服務器內部拋出錯誤

9

DB4403/T37-2019CB

附錄C

（資料性附錄）

認證與鑒權流程示例

C.1身份認證

數(shù)據(jù)獲取方根據(jù)已有賬號信息創(chuàng)建安全會話并獲取access_token（訪問令牌）。

C.1.1請求示例：

POST請求：https://ip:port/api/v{n}/auth/login

Content-Type:application/json

請求參數(shù)：

{

"app_key":"APP_KEY",

"app_secret":"APP_SECRET"

}

C.1.2返回結果：

{

"code":200,

"message":"success",

"access_token":"91440300792588888K",

"expires_in":"86400"

}

C.2訪問控制

數(shù)據(jù)獲取方根據(jù)獲取到的access_token調用接口。

C.2.1請求示例：

GET請求：https://ip:port/api/v{n}/resource/get_data?access_token=ACCESS_TOKEN

C.2.2返回結果：

a)正常返回結果：

{

"code":200,

"message":"success",

"data":[

{

"user_id":"1"

10

DB4403/T37-2019

"age":25

"user_name":張三

"creator":AAA

"create_time":2019-03-0116:00:00

"updater":null

"update_time":null

"remark":null

}

{

"user_id":"2"

"age":32

"user_name":李四

"creator":AAA

"create_time":2019-03-0116:00:00

"updater":null

"update_time":null

"remark":null

}

{

"user_id":"3"

"age":22

"user_name":王五

"creator":AAA

"create_time":2019-03-0116:00:00

"updater":null

"update_time":null

"remark":null

}

],

"total":5,

"page_name":1,

"size"：3,

"pages":2

}

b)異常返回結果：

{

"code":401,

"message":"用戶信息不存在"

}

C.3權限注銷

數(shù)據(jù)獲取方調用安全會話接口的logout方法，設置access_token為無效。