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

ICS

CCS

19DB5206 DB5206/T

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

specification

of

public

data

service

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

布

1572023

1572023本文件按照GB/T

本文件起草單位：銅仁市大數(shù)據(jù)發(fā)展管理局、貴州梵云大數(shù)據(jù)集團(tuán)有限公司、中國電信股份有限公司銅仁分公司、中國聯(lián)合網(wǎng)絡(luò)通信有限公司銅仁市分公司、浪潮云信息技術(shù)股份公司。本文件主要起草人：趙

輝、楊志剛、牟國強(qiáng)、

丹、

洋、高健東。II

1572023

范圍本文件規(guī)定了公共數(shù)據(jù)綜合服務(wù)平臺的術(shù)語和定義、縮略語、接口規(guī)范，以及實現(xiàn)接口的具體要求。本文件適用于銅仁市公共數(shù)據(jù)綜合服務(wù)平臺接口的設(shè)計與開發(fā)。

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

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

interface接口

interface將應(yīng)用程序的服務(wù)能力封裝成接口，并通過

API

網(wǎng)關(guān)開放給客戶端調(diào)用。銅仁市公共數(shù)據(jù)綜合服務(wù)平臺

tongren

public

data

integrated

service

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

resource

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

resource

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

接口共享

WEB

interface

sharing

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

縮略詞下列縮略詞適用于本文件。SOAP：簡單對象訪問協(xié)議（Simple

Object

Access

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

State

Transfer）。JSON：JS對象標(biāo)記（JavaScript

Object

Notation），一種輕量級的數(shù)據(jù)交換格式。HTTPS：超文本傳輸安全協(xié)議（Hyper

Text

Transfer

Protocol

over

SecureSocket

Layer）。Vn：版本號（Version

Number）。

接口規(guī)范5.1

接口類型5.1.1

REST:REST

服務(wù)消息封裝協(xié)議應(yīng)采用

HTTP

1.0/1.1

標(biāo)準(zhǔn)。5.1.2

Web

Service:Web

Service

服務(wù)消息封裝協(xié)議應(yīng)采用

SOAP

1.1/1.2

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

JSON

格式。資源提供方在發(fā)布服務(wù)的時候需要注明接口的實現(xiàn)方式。5.2

接口地址格式接口地址采用如下格式：https://ip:port/部門拼音簡寫/系統(tǒng)英文名稱/模塊英文名稱/業(yè)務(wù)操作英文名稱/版本號。部門拼音簡寫：用每個中文拼音的第一個字母。系統(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è)計傳入?yún)?shù)時，應(yīng)在Body中進(jìn)行傳遞，請求參數(shù)除了業(yè)務(wù)系統(tǒng)自身規(guī)定的參數(shù)外，還需包含表1的內(nèi)容。請求參數(shù)是必否須deptName請求部門名稱，用于獲知該服務(wù)被哪個部門調(diào)用。字符串deptCode請求部門編碼，用于獲知該服務(wù)被哪個部門調(diào)用。字符串programName請求程序名稱，用于獲知該服務(wù)被哪個業(yè)務(wù)程序調(diào)用。字符串userName用戶名，用于安全認(rèn)證，如果業(yè)務(wù)系統(tǒng)對安全有要求，可以讓資源需求方提供認(rèn)證信息，通過認(rèn)證后返回業(yè)務(wù)數(shù)據(jù)。字符串password用戶密碼，用于安全認(rèn)證，如果業(yè)務(wù)系統(tǒng)對安全有要求，可以讓資源需求方提供認(rèn)證信息，通過認(rèn)證后返回業(yè)務(wù)數(shù)據(jù)。字符串pageNo當(dāng)前頁（分頁參數(shù)），需要獲取分頁數(shù)據(jù)的時候使用，如果不是分頁數(shù)據(jù)，可以不提供。如果是分頁數(shù)據(jù)，默認(rèn)為

1。pageSize每頁記錄數(shù)（分頁參數(shù)），需要獲取分頁數(shù)據(jù)的時候使用，如果不是分頁數(shù)據(jù)，可以不提供。如果是分頁數(shù)據(jù)，默認(rèn)為AppKey通過申請獲取私人秘鑰。字符串

1572023表1