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

ICS35.100.01

L79

DB4403

深圳市地方標(biāo)準(zhǔn)

DB4403/T37—2019

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

Dataaccessspecificationsforintelligentsupervisionplatform

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

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

DB4403/T37-2019

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

1范圍

本標(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)通。

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

下列文件對(duì)于本文件的應(yīng)用是必不可少的。凡是注日期的引用文件，僅注日期的版本適用于本文件。

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

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

GB/T21063.4-2007政務(wù)信息資源目錄體系第4部分：政務(wù)信息資源分類(lèi)

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è)分類(lèi)

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

3術(shù)語(yǔ)和定義

下列術(shù)語(yǔ)和定義適用于本文件。

3.1

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

通過(guò)新一代信息技術(shù)與監(jiān)督職能相結(jié)合所建設(shè)的具有廉政風(fēng)險(xiǎn)防控、問(wèn)題線(xià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)察部門(mén)。

3.4

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

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

4縮略語(yǔ)

以下縮略語(yǔ)適用于本文件：

1

DB4403/T37-2019

API：應(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）

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

5.1總體模型

實(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ù)管理、數(shù)據(jù)目錄管理、接口管理、認(rèn)證與

鑒權(quán)、數(shù)據(jù)對(duì)接管理、數(shù)據(jù)安全管理及數(shù)據(jù)應(yīng)用管理等過(guò)程組成。數(shù)據(jù)接入流程參與對(duì)象分為數(shù)據(jù)提供

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

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

2

DB4403/T37-2019

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

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

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

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

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

由數(shù)據(jù)提供方將已進(jìn)行標(biāo)準(zhǔn)化處理的數(shù)據(jù)編制成數(shù)據(jù)目錄，并對(duì)數(shù)據(jù)目錄進(jìn)行管理。

5.2.3接口管理過(guò)程

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

5.2.4認(rèn)證與鑒權(quán)過(guò)程

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

法性和用戶(hù)權(quán)限的有效性，用戶(hù)只能在已有權(quán)限范圍內(nèi)進(jìn)行操作。

5.2.5數(shù)據(jù)對(duì)接管理過(guò)程

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

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

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

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

據(jù)安全。

5.2.7數(shù)據(jù)應(yīng)用管理過(guò)程

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

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

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

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

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

4.2的要求；

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

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

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

6.2.1概述

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

維護(hù)和訪(fǎng)問(wèn)等過(guò)程。

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

3

DB4403/T37-2019

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

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

編號(hào)數(shù)據(jù)項(xiàng)說(shuō)明

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

2名稱(chēng)數(shù)據(jù)的名稱(chēng)

3摘要對(duì)數(shù)據(jù)內(nèi)容的整體描述或說(shuō)明

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

5關(guān)鍵字對(duì)數(shù)據(jù)內(nèi)容的簡(jiǎn)要概括

6數(shù)據(jù)提供部門(mén)數(shù)據(jù)目錄來(lái)源部門(mén)

7行業(yè)分類(lèi)數(shù)據(jù)對(duì)應(yīng)的行業(yè)分類(lèi)

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

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

10更新頻率數(shù)據(jù)目錄更新頻率，如年、月、周、日等

11所屬行政區(qū)域生成數(shù)據(jù)目錄的部門(mén)所屬行政區(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ù)的方式

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

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

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

e)對(duì)于結(jié)構(gòu)化數(shù)據(jù)，應(yīng)提供完整的數(shù)據(jù)目錄；

f)對(duì)于非結(jié)構(gòu)化數(shù)據(jù)，應(yīng)先從中抽取出主要特征存儲(chǔ)到結(jié)構(gòu)化關(guān)系表中，再生成相應(yīng)的數(shù)據(jù)目錄。

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

數(shù)據(jù)提供方應(yīng)負(fù)責(zé)發(fā)布數(shù)據(jù)目錄信息，發(fā)布時(shí)應(yīng)指定允許訪(fǎng)問(wèn)數(shù)據(jù)目錄的用戶(hù)列表及訪(fǎng)問(wèn)權(quán)限，數(shù)

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

a)應(yīng)包括數(shù)據(jù)目錄內(nèi)容說(shuō)明；

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

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

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

不限于：

a)數(shù)據(jù)目錄變更管理流程應(yīng)包括變更申請(qǐng)、變更審批、變更實(shí)施、變更記錄等過(guò)程；

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

取方進(jìn)行審核。

6.2.5數(shù)據(jù)目錄訪(fǎng)問(wèn)

4

DB4403/T37-2019

數(shù)據(jù)提供方應(yīng)為數(shù)據(jù)獲取方提供具有訪(fǎng)問(wèn)全局?jǐn)?shù)據(jù)權(quán)限的賬號(hào)，以支持?jǐn)?shù)據(jù)獲取方讀取對(duì)應(yīng)的數(shù)

據(jù)資源。

6.3接口管理

6.3.1概述

數(shù)據(jù)提供方應(yīng)向數(shù)據(jù)獲取方提供數(shù)據(jù)資源訪(fǎng)問(wèn)接口，并提供接口描述及調(diào)用方法。數(shù)據(jù)提供方對(duì)接

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

程。

6.3.2接口設(shè)計(jì)

接口設(shè)計(jì)要求包括且不限于：

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

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

求格式示例參見(jiàn)附錄A；

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

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

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

時(shí)間（create_time）、更新人（update_person）、更新時(shí)間（update_time）、備注說(shuō)明（remark）

等；

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

6.3.3接口發(fā)布

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

b)接口發(fā)布內(nèi)容應(yīng)包括且不限于以下信息：

——接口說(shuō)明；

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

——接口調(diào)用示例文檔。

6.3.4接口維護(hù)

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

a)接口版本管理機(jī)制，將API版本號(hào)放入U(xiǎn)RL，多版本并存，采用增量的方式發(fā)布；

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

6.3.5接口訪(fǎng)問(wèn)

a)數(shù)據(jù)獲取方訪(fǎng)問(wèn)數(shù)據(jù)提供方數(shù)據(jù)的接口，具備讀取數(shù)據(jù)操作權(quán)限；

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

持?jǐn)?shù)據(jù)獲取方通過(guò)接口對(duì)數(shù)據(jù)的實(shí)時(shí)調(diào)用。

6.4認(rèn)證與鑒權(quán)

6.4.1概述

為保證數(shù)據(jù)的安全，數(shù)據(jù)的發(fā)布和調(diào)用應(yīng)經(jīng)過(guò)認(rèn)證與鑒權(quán)。

6.4.2數(shù)據(jù)發(fā)布的認(rèn)證與鑒權(quán)

5

DB4403/T37-2019

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

a)數(shù)據(jù)提供方初次訪(fǎng)問(wèn)統(tǒng)一數(shù)據(jù)接入系統(tǒng)時(shí)應(yīng)進(jìn)行注冊(cè)，并由數(shù)據(jù)獲取方進(jìn)行審核、授予相應(yīng)權(quán)

限；

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

6.4.3數(shù)據(jù)調(diào)用的認(rèn)證與鑒權(quán)

在數(shù)據(jù)調(diào)用的過(guò)程中：

a)數(shù)據(jù)提供方應(yīng)為數(shù)據(jù)獲取方提供可實(shí)時(shí)獲取全局?jǐn)?shù)據(jù)權(quán)限的賬號(hào)信息，并保證賬號(hào)信息及其權(quán)

限的有效性；

b)數(shù)據(jù)提供方應(yīng)對(duì)數(shù)據(jù)獲取方調(diào)用數(shù)據(jù)過(guò)程中的身份進(jìn)行認(rèn)證，并對(duì)其操作進(jìn)行鑒權(quán)；

c)相關(guān)認(rèn)證與鑒權(quán)流程參見(jiàn)附錄C。

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

6.5.1概述

數(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ù)目錄和接口等信息，訪(fǎng)問(wèn)并調(diào)用數(shù)據(jù)資源。

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

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

a)用戶(hù)管理，包括用戶(hù)注冊(cè)、登錄、注銷(xiāo)等功能；

b)權(quán)限管理，實(shí)現(xiàn)對(duì)用戶(hù)權(quán)限的統(tǒng)一管理；

c)數(shù)據(jù)目錄管理，實(shí)現(xiàn)對(duì)數(shù)據(jù)目錄發(fā)布、數(shù)據(jù)目錄維護(hù)和數(shù)據(jù)目錄訪(fǎng)問(wèn)等過(guò)程的管理；

d)數(shù)據(jù)接口管理，實(shí)現(xiàn)對(duì)接口發(fā)布、接口維護(hù)和接口訪(fǎng)問(wèn)等過(guò)程的管理；

e)數(shù)據(jù)預(yù)覽，用戶(hù)可通過(guò)在線(xiàn)預(yù)覽方式迅速獲取部分?jǐn)?shù)據(jù)快照信息；

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

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

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

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

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

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

才能正常發(fā)布；

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

及6.3的要求；

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

據(jù)。

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

6.6.1概述

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

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

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

6

DB4403/T37-2019

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

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

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

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

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

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

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

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

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

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

7

DB4403/T37-2019AA

附錄A

（資料性附錄）

接口請(qǐng)求格式示例

表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ù)類(lèi)型說(shuō)明

page否int頁(yè)碼

size否char(n)分頁(yè)大小

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

返回參數(shù)

參數(shù)名是否必傳數(shù)據(jù)類(lèi)型說(shuō)明

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

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

接口的主數(shù)據(jù)，即業(yè)務(wù)數(shù)據(jù)?？梢愿鶕?jù)實(shí)際返回?cái)?shù)組或者特定格

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

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

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

page否int當(dāng)前頁(yè)，列表查詢(xún)返回

size否int分頁(yè)大小，列表查詢(xún)返回

pages否int總頁(yè)數(shù)，列表查詢(xún)返回

8

BDB4403/T37-2019

附錄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訪(fǎng)問(wèn)令牌沒(méi)有提供，或者無(wú)效

403訪(fǎng)問(wèn)令牌有效，但沒(méi)有權(quán)限

404資源不存在

409資源沖突

422請(qǐng)求信息完整，但無(wú)效

500服務(wù)器內(nèi)部拋出錯(cuò)誤

9

DB4403/T37-2019CB

附錄C

（資料性附錄）

認(rèn)證與鑒權(quán)流程示例

C.1身份認(rèn)證

數(shù)據(jù)獲取方根據(jù)已有賬號(hào)信息創(chuàng)建安全會(huì)話(huà)并獲取access_token（訪(fǎng)問(wèn)令牌）。

C.1.1請(qǐng)求示例：

POST請(qǐng)求：https://ip:port/api/v{n}/auth/login

Content-Type:application/json

請(qǐng)求參數(shù)：

{

"app_key":"APP_KEY",

"app_secret":"APP_SECRET"

}

C.1.2返回結(jié)果：

{

"code":200,

"message":"success",

"access_token":"91440300792588888K",

"expires_in":"86400"

}

C.2訪(fǎng)問(wèn)控制

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

C.2.1請(qǐng)求示例：

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

C.2.2返回結(jié)果：

a)正常返回結(jié)果：

{

"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)異常返回結(jié)果：

{

"code":401,

"message":"用戶(hù)信息不存在"

}

C.3權(quán)限注銷(xiāo)

數(shù)據(jù)獲取方調(diào)用安全會(huì)話(huà)接口的logout方法，設(shè)置access_token為無(wú)效。