ICS03.080.99

CCSM19

DB5206

銅仁市地方標(biāo)準(zhǔn)

DB5206/T157-2023

公共數(shù)據(jù)綜合服務(wù)平臺接口規(guī)范

Interfacespecificationofpublicdataintegratedserviceplatform

2023-07-31發(fā)布2023-11-01實(shí)施

銅仁市市場監(jiān)督管理局發(fā)布

DB5206/T157—2023

目次

前言Ⅱ

1范圍1

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

3術(shù)語和定義1

4縮略詞2

5接口規(guī)范2

I

、

DB5206/T157—2023

前??言

本文件按照GB/T1.1-2020《標(biāo)準(zhǔn)化工作導(dǎo)則第1部分：標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則》的規(guī)定

起草。

本文件由銅仁市大數(shù)據(jù)發(fā)展管理局提出并歸口管理。

本文件起草單位：銅仁市大數(shù)據(jù)發(fā)展管理局、貴州梵云大數(shù)據(jù)集團(tuán)有限公司、中國電信股份有

限公司銅仁分公司、中國聯(lián)合網(wǎng)絡(luò)通信有限公司銅仁市分公司、浪潮云信息技術(shù)股份公司。

本文件主要起草人：趙將、雷宏、陳丹、陳進(jìn)軍、李正隆、向輝、楊志剛、牟國強(qiáng)、

楊黔波、宋賀楠、程興章、施波、楊凡、萬嘉華、楊勝明、魯泓潁、李宗亮、桂先元、李丹、

譚仁飛、陳敏、呂熹、申洋、高健東。

II

、

DB5206/T157—2023

公共數(shù)據(jù)綜合服務(wù)平臺接口規(guī)范

1范圍

本文件規(guī)定了公共數(shù)據(jù)綜合服務(wù)平臺的術(shù)語和定義、縮略語、接口規(guī)范，以及實(shí)現(xiàn)接口的具體

要求。

本文件適用于銅仁市公共數(shù)據(jù)綜合服務(wù)平臺接口的設(shè)計(jì)與開發(fā)。

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

本文件沒有規(guī)范性引用文件。

3術(shù)語和定義

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

3.1

接口interface

將應(yīng)用程序的服務(wù)能力封裝成接口，并通過API網(wǎng)關(guān)開放給客戶端調(diào)用。

3.2

銅仁市公共數(shù)據(jù)綜合服務(wù)平臺tongrenpublicdataintegratedserviceplatform

為全市數(shù)據(jù)提供共享交換的服務(wù)平臺。

3.3

資源提供方resourceproviders

通過銅仁市公共數(shù)據(jù)綜合服務(wù)平臺提供資源的實(shí)體。

3.4

資源需求方resourcedemanders

通過銅仁市公共數(shù)據(jù)綜合服務(wù)平臺獲取資源的實(shí)體。

3.5

WEB接口共享WEBinterfacesharing

通過WEB接口方式進(jìn)行數(shù)據(jù)共享，經(jīng)直接封裝或前置機(jī)封裝，通過目錄中心和交換中心發(fā)布成功

1

DB5206/T157—2023

后進(jìn)行的數(shù)據(jù)交換。

4縮略詞

下列縮略詞適用于本文件。

SOAP：簡單對象訪問協(xié)議（SimpleObjectAccessProtocol）。

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

JSON：JS對象標(biāo)記（JavaScriptObjectNotation），一種輕量級的數(shù)據(jù)交換格式。

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

Vn：版本號（VersionNumber）。

5接口規(guī)范

5.1接口類型

5.1.1REST:REST服務(wù)消息封裝協(xié)議應(yīng)采用HTTP1.0/1.1標(biāo)準(zhǔn)。

5.1.2WebService:WebService服務(wù)消息封裝協(xié)議應(yīng)采用SOAP1.1/1.2標(biāo)準(zhǔn)。

資源提供方可以選擇其中一種方式進(jìn)行開發(fā)，返回的結(jié)果都采用JSON格式。資源提供方在發(fā)

布服務(wù)的時(shí)候需要注明接口的實(shí)現(xiàn)方式。

5.2接口地址格式

接口地址采用如下格式：

https://ip:port/部門拼音簡寫/系統(tǒng)英文名稱/模塊英文名稱/業(yè)務(wù)操作英文名稱/版本號。

部門拼音簡寫：用每個(gè)中文拼音的第一個(gè)字母。

系統(tǒng)英文名稱：系統(tǒng)的英文縮寫，由服務(wù)提供者自行定義。

模塊英文名稱：模塊的英文縮寫，由服務(wù)提供者自行定義。

業(yè)務(wù)操作英文名稱：業(yè)務(wù)操作處理的英文縮寫，由服務(wù)提供者自行定義。

版本號：用Vn進(jìn)行定義。

5.3接口請求方式

接口請求方式應(yīng)使用GET和POST。

GET：如果資源需求方要獲取資源提供方的信息，采用GET請求方式。

POST：如果資源需求方要提交信息給資源提供方，采用POST請求。

5.4接口請求參數(shù)

資源需求方在設(shè)計(jì)傳入?yún)?shù)時(shí)，應(yīng)在Body中進(jìn)行傳遞，請求參數(shù)除了業(yè)務(wù)系統(tǒng)自身規(guī)定的參數(shù)

外，還需包含表1的內(nèi)容。

2

DB5206/T157—2023

表1請求參數(shù)類型

請求參數(shù)說明是必否須類型

deptName請求部門名稱，用于獲知該服務(wù)被哪個(gè)部門調(diào)用。是字符串

deptCode請求部門編碼，用于獲知該服務(wù)被哪個(gè)部門調(diào)用。否字符串

programName請求程序名稱，用于獲知該服務(wù)被哪個(gè)業(yè)務(wù)程序調(diào)用。是字符串

用戶名，用于安全認(rèn)證，如果業(yè)務(wù)系統(tǒng)對安全有要求，可以

userName否字符串

讓資源需求方提供認(rèn)證信息，通過認(rèn)證后返回業(yè)務(wù)數(shù)據(jù)。

用戶密碼，用于安全認(rèn)證，如果業(yè)務(wù)系統(tǒng)對安全有要求，可

password否字符串

以讓資源需求方提供認(rèn)證信息，通過認(rèn)證后返回業(yè)務(wù)數(shù)據(jù)。

當(dāng)前頁（分頁參數(shù)），需要獲取分頁數(shù)據(jù)的時(shí)候使用，如果

pageNo否數(shù)字

不是分頁數(shù)據(jù)，可以不提供。如果是分頁數(shù)據(jù)，默認(rèn)為1。

每頁記錄數(shù)（分頁參數(shù)），需要獲取分頁數(shù)據(jù)的時(shí)候使用，

pageSize如果不是分頁數(shù)據(jù)，可以不提供。如果是分頁數(shù)據(jù)，默認(rèn)為否數(shù)字

10。

AppKey通過申請獲取私人秘鑰。是字符串

5.5接口應(yīng)答內(nèi)容

接口成功接到請求，應(yīng)返回狀態(tài)碼，并采用如下數(shù)據(jù)格式封裝：

Code：執(zhí)行結(jié)