DB37-T 4560.4-2022 政府網(wǎng)站集約化平臺(tái) 第4部分:接口規(guī)范_第1頁(yè)
DB37-T 4560.4-2022 政府網(wǎng)站集約化平臺(tái) 第4部分:接口規(guī)范_第2頁(yè)
DB37-T 4560.4-2022 政府網(wǎng)站集約化平臺(tái) 第4部分:接口規(guī)范_第3頁(yè)
DB37-T 4560.4-2022 政府網(wǎng)站集約化平臺(tái) 第4部分:接口規(guī)范_第4頁(yè)
DB37-T 4560.4-2022 政府網(wǎng)站集約化平臺(tái) 第4部分:接口規(guī)范_第5頁(yè)
已閱讀5頁(yè),還剩12頁(yè)未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說(shuō)明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡(jiǎn)介

ICS35.240.99

CCSL67

37

山東省地方標(biāo)準(zhǔn)

DB37/T4560.4—2022

政府網(wǎng)站集約化平臺(tái)

第4部分:接口規(guī)范

Intensiveplatformofgovernmentwebsites—Part4:Interfacespecifications

2022-11-30發(fā)布2022-12-30實(shí)施

山東省市場(chǎng)監(jiān)督管理局發(fā)布

DB37/T4560.4—2022

政府網(wǎng)站集約化平臺(tái)

第4部分:接口規(guī)范

1范圍

本文件規(guī)定了政府網(wǎng)站集約化平臺(tái)(以下簡(jiǎn)稱“集約化平臺(tái)”)間、集約化平臺(tái)與政府網(wǎng)站信息資

源共享庫(kù)間對(duì)接的接口要求。

本文件適用于各級(jí)集約化平臺(tái)通過(guò)接口進(jìn)行的共享交換。

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

下列文件中的內(nèi)容通過(guò)文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中,注日期的引用文件,

僅該日期對(duì)應(yīng)的版本適用于本文件;不注日期的引用文件,其最新版本(包括所有的修改單)適用于本

文件。

DB37/T4560.1政府網(wǎng)站集約化平臺(tái)第1部分:總體要求

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

DB37/T4560.1界定的術(shù)語(yǔ)和定義適用于本文件。

4縮略語(yǔ)

下列縮略語(yǔ)適用于本文件。

HTTP:超文本傳輸協(xié)議(HyperTextTransferProtocol)

HTTPS:超文本安全傳輸協(xié)議(HyperTextTransferProtocolSecure)

ID:身份標(biāo)識(shí)碼(IdentityDocument)

JSON:JavaScript對(duì)象簡(jiǎn)譜(JavaScriptObjectNotation)

URL:統(tǒng)一資源定位器(UniformResourceLocator)

UUID:唯一通用標(biāo)識(shí)碼(UniversallyUniqueIdentifier)

5接口目錄

政府網(wǎng)站信息資源(以下簡(jiǎn)稱“信息資源”)對(duì)接接口包括各集約化平臺(tái)間的對(duì)接接口、集約化平

臺(tái)與政府網(wǎng)站信息資源共享庫(kù)間的對(duì)接接口,接口目錄見表1。

1

DB37/T4560.4—2022

表1接口目錄

序號(hào)接口分類接口名稱

1信息資源同步

2各集約化平臺(tái)間對(duì)接接口附件上傳

3信息資源獲取

4信息資源列表查詢

5信息資源獲取

6信息資源新增

集約化平臺(tái)與政府網(wǎng)站信息資源共享庫(kù)間對(duì)接接口

7信息資源修改

8信息資源刪除

9信息資源移動(dòng)

6接口表示要求

接口表示要求包括但不限于:

a)接口描述:應(yīng)描述出接口的功能概要信息;

b)接口方式:應(yīng)給出接口采用的請(qǐng)求方式;

c)輸入?yún)?shù):應(yīng)給出參數(shù)名稱、數(shù)據(jù)類型、說(shuō)明等輸入信息;

d)輸出參數(shù):若有輸出參數(shù),應(yīng)給出參數(shù)名稱、數(shù)據(jù)類型、說(shuō)明等輸出信息;

e)接口返回示例:應(yīng)給出接口返回示例,接口返回示例見附錄A、附錄B。

接口輸入?yún)?shù)、輸出參數(shù)中允許的數(shù)據(jù)類型見表2。

表2參數(shù)數(shù)據(jù)類型

數(shù)據(jù)類型說(shuō)明

字符型通過(guò)字符形式表達(dá)的值的類型

數(shù)字型通過(guò)從“0”到“9”數(shù)字形式表達(dá)的值的類型

日期型通過(guò)YYYY—MM—DD的形式表達(dá)的值的類型,符合GB/T7408

通過(guò)YYYYMMDDhhmmss或YYYY—MM—DDhh:mm:ss的形式表達(dá)的值的類型,符合GB/T

日期時(shí)間型

7408

7各集約化平臺(tái)間對(duì)接接口

7.1信息資源同步

7.1.1接口描述

用于向其他集約化平臺(tái)推送信息資源。

7.1.2接口方式

接口方式為HTTP/HTTPS。

2

DB37/T4560.4—2022

7.1.3輸入?yún)?shù)

接口輸入?yún)?shù)見表3。

表3輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1站點(diǎn)ID數(shù)字型信息資源所屬站點(diǎn)的數(shù)字編號(hào)

2欄目ID數(shù)字型信息資源所屬欄目的數(shù)字編號(hào)

3時(shí)間戳數(shù)字型記錄獲取信息資源的時(shí)間,單位精確至毫秒

4站點(diǎn)簽名值字符型用于驗(yàn)證同步信息資源的來(lái)源站點(diǎn)

5信息內(nèi)容字符型推送的信息資源具體內(nèi)容

7.1.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表4。

表4輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

7.1.5接口返回示例

接口返回示例見A.1。

7.2附件上傳

7.2.1接口描述

用于向其他集約化平臺(tái)同步信息資源時(shí)附件的上傳。

7.2.2接口方式

接口方式為HTTP/HTTPS。

7.2.3輸入?yún)?shù)

接口輸入?yún)?shù)見表5。

3

DB37/T4560.4—2022

表5輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1站點(diǎn)ID數(shù)字型附件上傳站點(diǎn)的數(shù)字編號(hào)

2欄目ID數(shù)字型附件上傳欄目的數(shù)字編號(hào)

3時(shí)間戳數(shù)字型記錄獲取信息資源的時(shí)間,單位精確至毫秒

4站點(diǎn)簽名值字符型用來(lái)驗(yàn)證同步信息資源的來(lái)源站點(diǎn)

5附件信息字符型上傳的附件信息內(nèi)容,包括附件名稱、訪問(wèn)鏈接等

7.2.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表6。

表6輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

7.2.5接口返回示例

接口返回示例見A.2。

7.3信息資源獲取

7.3.1接口描述

用于從其他集約化平臺(tái)獲取所需的信息資源。

7.3.2接口方式

接口方式為HTTP/HTTPS。

7.3.3輸入?yún)?shù)

接口輸入?yún)?shù)見表7。

表7輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1站點(diǎn)ID數(shù)字型信息資源所屬站點(diǎn)的數(shù)字編號(hào)

2欄目ID數(shù)字型信息資源所屬欄目的數(shù)字編號(hào)

3時(shí)間戳數(shù)字型記錄獲取信息資源的時(shí)間,單位精確至毫秒

4

DB37/T4560.4—2022

表7輸入?yún)?shù)(續(xù))

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

4站點(diǎn)簽名值字符型用來(lái)驗(yàn)證同步信息資源的來(lái)源站點(diǎn)

信息資源發(fā)布區(qū)間的起始時(shí)間,YYYY—MM—DDhh:mm:ss的形式,符

5起始時(shí)間日期時(shí)間型

合GB/T7408

信息資源發(fā)布區(qū)間的結(jié)束時(shí)間,YYYY—MM—DDhh:mm:ss的形式,符

6結(jié)束時(shí)間日期時(shí)間型

合GB/T7408

7.3.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表8。

表8輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

3信息內(nèi)容

字符型獲取的信息資源具體內(nèi)容

7.3.5接口返回示例

接口返回示例見A.3。

8集約化平臺(tái)與政府網(wǎng)站信息資源共享庫(kù)對(duì)接接口

8.1信息資源列表查詢

8.1.1接口描述

用于通過(guò)指定欄目ID查詢政府網(wǎng)站信息資源共享庫(kù)的信息資源,僅展現(xiàn)指定欄目下的信息資源列表,

并不查看具體信息資源內(nèi)容。

8.1.2接口方式

接口方式為HTTP/HTTPS。

8.1.3輸入?yún)?shù)

接口輸入?yún)?shù)見表9。

5

DB37/T4560.4—2022

表9輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1集約化平臺(tái)ID數(shù)字型指定欄目所屬集約化平臺(tái)的數(shù)字編號(hào)

2政府網(wǎng)站ID數(shù)字型指定欄目所屬政府網(wǎng)站的數(shù)字編號(hào)

3欄目ID數(shù)字型指定欄目的數(shù)字編號(hào)

4關(guān)鍵詞字符型查詢信息資源時(shí)輸入的關(guān)鍵字

信息資源檢索范圍代碼;

0-全字段;

5查詢范圍數(shù)字型

1-作者;

2-標(biāo)題

查詢信息資源的開始時(shí)間,YYYY—MM—DDhh:mm:ss的形式,符合GB/T

6開始時(shí)間日期時(shí)間型

7408

查詢信息資源的結(jié)束時(shí)間,YYYY—MM—DDhh:mm:ss的形式,符合GB/T

7結(jié)束時(shí)間日期時(shí)間型

7408

8.1.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表10。

表10輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

3信息資源總數(shù)數(shù)字型查詢到的信息資源總體數(shù)量

4信息資源UUID字符型信息資源的唯一標(biāo)識(shí),長(zhǎng)度不超過(guò)64位

5信息資源標(biāo)題字符型信息資源的標(biāo)題

8.1.5接口返回示例

接口返回示例見B.1。

8.2信息資源獲取

8.2.1接口描述

用于獲取信息資源的詳細(xì)內(nèi)容。

8.2.2接口方式

接口方式為HTTP/HTTPS。

6

DB37/T4560.4—2022

8.2.3輸入?yún)?shù)

接口輸入?yún)?shù)見表11。

表11輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1集約化平臺(tái)ID數(shù)字型信息資源所屬集約化平臺(tái)的數(shù)字編號(hào)

2政府網(wǎng)站ID數(shù)字型信息資源所屬政府網(wǎng)站的數(shù)字編號(hào)

3欄目ID數(shù)字型信息資源所屬欄目的數(shù)字編號(hào)

4信息資源UUID字符型信息資源的唯一標(biāo)識(shí),長(zhǎng)度不超過(guò)64位

8.2.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表12。

表12輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

3集約化平臺(tái)ID數(shù)字型信息資源所屬集約化平臺(tái)的數(shù)字編號(hào)

信息

4政府網(wǎng)站ID數(shù)字型信息資源所屬政府網(wǎng)站的數(shù)字編號(hào)

資源

5欄目ID數(shù)字型信息資源所屬欄目的數(shù)字編號(hào)

內(nèi)容

6信息內(nèi)容字符型信息資源的具體內(nèi)容

7集約化平臺(tái)ID數(shù)字型引用信息資源所屬集約化平臺(tái)的數(shù)字編號(hào)

8引用政府網(wǎng)站ID數(shù)字型引用信息資源所屬政府網(wǎng)站的數(shù)字編號(hào)

9信息欄目ID數(shù)字型引用信息資源所屬欄目的數(shù)字編號(hào)

10信息資源UUID字符型引用信息資源的唯一標(biāo)識(shí),長(zhǎng)度不超過(guò)64位

11信息資源URL字符型信息資源的訪問(wèn)URL

8.2.5接口返回示例

接口返回示例見B.2。

8.3信息資源新增

8.3.1接口描述

用于向政府網(wǎng)站信息資源共享庫(kù)新增信息資源。

8.3.2接口方式

7

DB37/T4560.4—2022

接口方式為HTTP/HTTPS。

8.3.3輸入?yún)?shù)

接口輸入?yún)?shù)見表13。

表13輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1集約化平臺(tái)ID數(shù)字型新增信息資源所屬集約化平臺(tái)的數(shù)字編號(hào)

2政府網(wǎng)站ID數(shù)字型新增信息資源所屬政府網(wǎng)站的數(shù)字編號(hào)

3欄目ID數(shù)字型新增信息資源所屬欄目的數(shù)字編號(hào)

4信息內(nèi)容字符型新增信息資源的具體內(nèi)容

5信息資源URL字符型新增信息資源的訪問(wèn)URL

8.3.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表14。

表14輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

3信息資源UUID字符型新增信息資源的唯一標(biāo)識(shí),長(zhǎng)度不超過(guò)64位

8.3.5接口返回示例

接口返回示例見B.3。

8.4信息資源修改

8.4.1接口描述

用于修改政府網(wǎng)站信息資源共享庫(kù)的信息資源。

8.4.2接口方式

接口方式為HTTP/HTTPS。

8.4.3輸入?yún)?shù)

接口輸入?yún)?shù)見表15。

8

DB37/T4560.4—2022

表15輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1集約化平臺(tái)ID數(shù)字型信息資源所屬集約化平臺(tái)的數(shù)字編號(hào)

2政府網(wǎng)站ID數(shù)字型信息資源所屬政府網(wǎng)站的數(shù)字編號(hào)

3欄目ID數(shù)字型信息資源所屬欄目的數(shù)字編號(hào)

4信息資源UUID字符型信息資源的唯一標(biāo)識(shí),長(zhǎng)度不超過(guò)64位

5信息內(nèi)容字符型信息資源修改后的具體內(nèi)容

6信息資源URL字符型信息資源的訪問(wèn)URL

8.4.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表16。

表16輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

8.4.5接口返回示例

接口返回示例見B.4。

8.5信息資源刪除

8.5.1接口描述

用于刪除政府網(wǎng)站信息資源共享庫(kù)的信息資源。

8.5.2接口方式

接口方式為HTTP/HTTPS。

8.5.3輸入?yún)?shù)

接口輸入?yún)?shù)見表17。

表17輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1集約化平臺(tái)ID數(shù)字型信息資源所屬集約化平臺(tái)的數(shù)字編號(hào)

2政府網(wǎng)站ID數(shù)字型信息資源所屬政府網(wǎng)站的數(shù)字編號(hào)

9

DB37/T4560.4—2022

表17輸入?yún)?shù)(續(xù))

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

3欄目ID數(shù)字型信息資源所屬欄目的數(shù)字編號(hào)

4信息資源UUID字符型信息資源的唯一標(biāo)識(shí),長(zhǎng)度不超過(guò)64位

8.5.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表18的要求。

表18輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

8.5.5接口返回示例

接口返回示例見B.5。

8.6信息資源移動(dòng)

8.6.1接口描述

用于修改政府網(wǎng)站信息資源共享庫(kù)的信息資源存放路徑。

8.6.2接口方式

接口方式為HTTP/HTTPS。

8.6.3輸入?yún)?shù)

接口輸入?yún)?shù)見表19。

表19輸入?yún)?shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

1原集約化平臺(tái)ID數(shù)字型信息資源所屬集約化平臺(tái)的數(shù)字編號(hào),可為空值

2目標(biāo)集約化平臺(tái)ID數(shù)字型信息資源移動(dòng)后所屬集約化平臺(tái)的數(shù)字編號(hào)

3原政府網(wǎng)站ID字符型信息資源所屬政府網(wǎng)站的數(shù)字編號(hào),可為空值

4目標(biāo)政府網(wǎng)站ID字符型信息資源移動(dòng)后所屬政府網(wǎng)站的數(shù)字編號(hào)

5原欄目ID字符型信息資源所屬欄目的數(shù)字編號(hào),可為空值

6目標(biāo)欄目ID字符型信息資源移動(dòng)后所屬欄目的數(shù)字編號(hào)

10

DB37/T4560.4—2022

表19輸入?yún)?shù)(續(xù))

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

7信息資源UUID字符型信息資源的唯一標(biāo)識(shí),長(zhǎng)度不超過(guò)64位

8信息資源URL字符型信息資源的訪問(wèn)URL

8.6.4輸出參數(shù)

返回JSON字符串,接口輸出參數(shù)見表20。

表20輸出參數(shù)

序號(hào)參數(shù)名稱數(shù)據(jù)類型說(shuō)明

返回碼:

1返回碼數(shù)字型0-成功;

1-失敗

2返回結(jié)果字符型返回結(jié)果描述信息

8.6.5接口返回示例

接口返回示例見B.6。

11

DB37/T4560.4—2022

附錄A

(資料性)

各集約化平臺(tái)間對(duì)接接口返回示例

A.1信息資源同步

下面給出來(lái)信息資源同步接口返回示例。

示例:

{"code":"0","message":"信息資源同步完成!"}

A.2附件上傳

下面給出來(lái)附件上傳接口返回示例。

示例:

{"code":"0","message":"附件上傳成功!"}

A.3信息資源獲取

下面給出來(lái)信息資源獲取接口返回示例。

示例:

{

"code":"0",

"message":"信息資源獲取成功!",

"resultData":[{

"i_id":"7",

"vc_author":"",

"vc_flash":"",

"vc_title":"測(cè)試標(biāo)題",

"vc_userid":"00000",

"vc_keyword":"",

"vc_pic":"http://test/picture/0/s_4537adc21a1d4bd6b3dedcfb4074aeb9.jpg",

"vc_editor":"系統(tǒng)管理員",

"vc_thdtitle":"測(cè)試引題",

"vc_cataname":"多信息欄目",

"blink":"http://test/art/2021/12/14/art_10_7.html",

"vc_media":"",

"vc_sectitle":"測(cè)試副標(biāo)題",

"vc_content":"測(cè)試正文社會(huì)主義核心價(jià)值觀",

"vc_source":"",

"c_createdate":"2021-12-1411:46:48",

"i_cataid":"10",

"vc_webname":"這是測(cè)試政府網(wǎng)站",

"vc_attach":"http://test/attach/0/3b38ff7f76c94006a8b3f8e1c9e8a1ee.txt",

"vc_describe":"",

12

DB37/T4560.4—2022

"i_webid":"3",

"c_deploytime":"2021-12-1411:46:48",

"vc_auditprogram":"單位審核公開",

"vc_jd":"csjd1",

"b_xxgk":"1",

"vc_zpfl":"zp1",

"vc_filenumber":"",

"vc_ztfl":"zt1",

"c_complatedate":"2021-06-27",

"vc_fbjg":"asd",

"vc_tcfl":"tc1"

}]

}

13

DB37/T4560.4—2022

附錄B

(資料性)

集約化平臺(tái)與政府網(wǎng)站信息資源共享庫(kù)對(duì)接接口返回示例

B.1信息資源列表查詢

下面給出來(lái)信息資源列表查詢接口返回示例。

示例:

{"code":"0","message":"信息資源列表查詢成功!",

"infoList":{

"total":"288",

"records":[

溫馨提示

  • 1. 本站所有資源如無(wú)特殊說(shuō)明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁(yè)內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒(méi)有圖紙預(yù)覽就沒(méi)有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫(kù)網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

評(píng)論

0/150

提交評(píng)論