ICS01.080.30

CCSL04

DB63

青海省地方標(biāo)準(zhǔn)

DB63/T2019—2022

市場(chǎng)監(jiān)管大數(shù)據(jù)平臺(tái)接口規(guī)范

2022-03-10發(fā)布2022-04-10實(shí)施

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

DB63/T2019—2022

目次

前言................................................................................II

1范圍..............................................................................1

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

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

3.1接口..........................................................................1

3.2協(xié)議..........................................................................1

4縮略語(yǔ)............................................................................1

5接口總體要求......................................................................1

5.1接口方式......................................................................1

5.2接口返回?cái)?shù)據(jù)格式..............................................................1

5.3接口調(diào)用地址..................................................................2

5.4部分接口調(diào)用參數(shù)說(shuō)明..........................................................2

6統(tǒng)一身份認(rèn)證接口..................................................................2

6.1獲取授權(quán)碼接口................................................................2

6.2獲取訪(fǎng)問(wèn)令牌接口..............................................................2

6.3刷新令牌接口..................................................................3

6.4退出登錄接口..................................................................3

7數(shù)據(jù)上傳接口......................................................................4

8數(shù)據(jù)更新接口......................................................................5

9數(shù)據(jù)刪除接口......................................................................5

10數(shù)據(jù)查詢(xún)接口.....................................................................6

I

DB63/T2019—2022

前言

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

草。

本文件由青海省市場(chǎng)監(jiān)督管理局提出并歸口。

本文件主要起草單位：青海省市場(chǎng)監(jiān)督管理局信息中心。

本文件主要起草人：馬玉成、王向文、王逸軒、李瑛、周繼輝、何海超、董雪彤、李偉、劉宇靜、

汪國(guó)孝。

本文件由青海省市場(chǎng)監(jiān)督管理局監(jiān)督實(shí)施。

II

DB63/T2019—2022

市場(chǎng)監(jiān)管大數(shù)據(jù)平臺(tái)接口規(guī)范

1范圍

本文件規(guī)定了市場(chǎng)監(jiān)管大數(shù)據(jù)平臺(tái)接口總體要求、統(tǒng)一身份認(rèn)證、數(shù)據(jù)上傳、數(shù)據(jù)更新、數(shù)據(jù)刪除、

數(shù)據(jù)查詢(xún)接口規(guī)范。

本文件適用于市場(chǎng)監(jiān)管業(yè)務(wù)系統(tǒng)和其它信息系統(tǒng)與市場(chǎng)監(jiān)管大數(shù)據(jù)平臺(tái)之間通過(guò)接口進(jìn)行數(shù)據(jù)共

享和傳輸。

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

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

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

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

3.1

接口

進(jìn)行信息交換時(shí)通信雙方需要遵從的通信方式和要求。

3.2

協(xié)議

服務(wù)端和客戶(hù)端必須共同遵循的一組約定。

4縮略語(yǔ)

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

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

JSON：JavaScript對(duì)象標(biāo)記語(yǔ)言（JavaScriptObjectNotation）

RESTful：REST風(fēng)格的網(wǎng)絡(luò)接口

5接口總體要求

5.1接口方式

市場(chǎng)監(jiān)管大數(shù)據(jù)平臺(tái)的接口統(tǒng)一采用RESTful架構(gòu)風(fēng)格的Web服務(wù)。

接口訪(fǎng)問(wèn)采用HTTPS協(xié)議的GET和POST方式。

1

DB63/T2019—2022

5.2接口返回?cái)?shù)據(jù)格式

接口返回?cái)?shù)據(jù)采用JSON格式。詳見(jiàn)每個(gè)接口的詳細(xì)描述。

5.3接口調(diào)用地址

本規(guī)范接口調(diào)用地址中的“https://ip:port”在實(shí)際調(diào)用時(shí)，需要把其中的“ip”和“port”修

改為市場(chǎng)監(jiān)管大數(shù)據(jù)平臺(tái)提供的真實(shí)IP地址和訪(fǎng)問(wèn)端口。

5.4部分接口調(diào)用參數(shù)說(shuō)明

dataName：數(shù)據(jù)對(duì)象名稱(chēng)。外部對(duì)接系統(tǒng)可以使用的數(shù)據(jù)對(duì)象名稱(chēng)需要在使用前向市場(chǎng)監(jiān)管大數(shù)據(jù)

平臺(tái)申請(qǐng)。如：“食品從業(yè)人員信息”、“藥品零售企業(yè)信息”等。

dataValue：描述一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例的JSON字符串。該JSON字符串包含一個(gè)數(shù)組對(duì)象，每個(gè)

數(shù)組元素是一個(gè)數(shù)據(jù)對(duì)象實(shí)例。如：

"{

"單位名稱(chēng)":"蜀香火鍋店",

"負(fù)責(zé)人":"張大明"

}"

6統(tǒng)一身份認(rèn)證接口

6.1獲取授權(quán)碼接口

調(diào)用地址：https://ip:port/OAuth/Authorize

調(diào)用方式：HTTP的GET方法。

調(diào)用參數(shù)：見(jiàn)表1。

表1獲取授權(quán)碼接口調(diào)用參數(shù)

參數(shù)名類(lèi)型必填說(shuō)明舉例

client_id字符串是應(yīng)用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_id"75ef2134-981b-4

56c-f63c-08d882c

de193"

client_secret字符串是應(yīng)用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_secret"78juqyes"

scope字符串是應(yīng)用向大數(shù)據(jù)平臺(tái)請(qǐng)求的屬性"app"

redirect_uri字符串是認(rèn)證完成并且用戶(hù)對(duì)應(yīng)用授權(quán)后跳轉(zhuǎn)的地"https://ip:port

址，此地址可以得到grant_code授權(quán)碼/callback"

response_type字符串是值固定為“code”"code"

返回值：JSON對(duì)象，對(duì)象的屬性說(shuō)明和示例如下。

{

"grant_code":"3092"http://獲取到的授權(quán)碼

}

6.2獲取訪(fǎng)問(wèn)令牌接口

調(diào)用地址：https://ip:port/OAuth/Access_Token

2

DB63/T2019—2022

調(diào)用方式：HTTP的GET方法。

調(diào)用參數(shù)：見(jiàn)表2。

表2獲取訪(fǎng)問(wèn)令牌接口調(diào)用參數(shù)

參數(shù)名類(lèi)型必填說(shuō)明舉例

client_id字符串是應(yīng)用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_id"75ef2134-981b-4

56c-f63c-08d882c

de193"

client_secret字符串是應(yīng)用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_secret"78juqyes"

scope字符串是應(yīng)用向大數(shù)據(jù)平臺(tái)請(qǐng)求的屬性"app"

redirect_uri字符串是認(rèn)證完成并且用戶(hù)對(duì)應(yīng)用授權(quán)后跳轉(zhuǎn)的地"https://ip:port

址/callback"

grant_type字符串是值固定為“authorization_code”"authorization_c

ode"

code字符串是通過(guò)“獲取授權(quán)碼接口”獲取到的授權(quán)碼"3092"

返回值：JSON對(duì)象，對(duì)象的屬性說(shuō)明和示例如下。

{

"expires_in":7200,//令牌有效期，單位“秒”

"token_type":"Bearer",//獲得的令牌類(lèi)型為"Bearer"

"access_token":"a23098ca-8584-4d76-f63b-08d882cde193"http://訪(fǎng)問(wèn)令牌

}

6.3刷新令牌接口

調(diào)用地址：https://ip:port/OAuth/Refresh_Token

調(diào)用方式：HTTP的GET方法。

調(diào)用參數(shù)：見(jiàn)表3。

表3刷新令牌接口調(diào)用參數(shù)

參數(shù)名類(lèi)型必填說(shuō)明舉例

client_id字符串是應(yīng)用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_id"75ef2134-981b-4

56c-f63c-08d882c

de193"

access_token字符串是訪(fǎng)問(wèn)令牌"a23098ca-8584-4

d76-f63b-08d882c

de193"

返回值：JSON對(duì)象，對(duì)象的屬性說(shuō)明和示例如下。

{

"expires_in":7200,//令牌有效期，單位“秒”

"token_type":"Bearer",//獲得的令牌類(lèi)型為"Bearer"

"access_token":"82553e7e-2647-4307-b8a0-08d840293f1a"http://新的訪(fǎng)問(wèn)令牌

}

6.4退出登錄接口

3

DB63/T2019—2022

調(diào)用地址：https://ip:port/OAuth/Logout

調(diào)用方式：HTTP的GET方法。

調(diào)用參數(shù)：見(jiàn)表4。

表4退出登錄接口調(diào)用參數(shù)

參數(shù)名類(lèi)型必填說(shuō)明舉例

tk字符串是訪(fǎng)問(wèn)令牌"a23098ca-8584-4

d76-f63b-08d882c

de193"

redirect_uri字符串是"https://ip:port

退出登陸后跳轉(zhuǎn)的地址

/home"

返回值：無(wú)，直接跳轉(zhuǎn)redirect_uri指定的地址。

7數(shù)據(jù)上傳接口

調(diào)用地址：https://ip:port/data/add

調(diào)用方式：HTTP的POST方法。

調(diào)用參數(shù)：見(jiàn)表5。

表5數(shù)據(jù)上傳接口調(diào)用參數(shù)

參數(shù)名類(lèi)型必填說(shuō)明舉例

"a23098ca-8584-4

tk字符串是訪(fǎng)問(wèn)令牌d76-f63b-08d882c

de193"

dataName字符串是數(shù)據(jù)對(duì)象名稱(chēng)"食品經(jīng)營(yíng)許可證"

[{

"單位名稱(chēng)":"蜀香

火鍋店",

"負(fù)責(zé)人":"張大明

"

描述一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例的JSON字符

dataValue字符串是},{

串

"單位名稱(chēng)":"馬學(xué)

軍牛肉面",

"負(fù)責(zé)人":"馬學(xué)福

"

}]

返回值：JSON對(duì)象，對(duì)象的屬性說(shuō)明和示例如下。

{

"Success":true,//請(qǐng)求的操作是否成功。調(diào)用本接口時(shí)傳遞的一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例全

部上傳成功時(shí)才會(huì)返回true。

"Errors":[],//當(dāng)Success為true時(shí)返回空數(shù)組；

4

DB63/T2019—2022

//當(dāng)Success為false時(shí)平臺(tái)返回1個(gè)或多個(gè)錯(cuò)誤信息字符串。如：["參數(shù)

dataValue的值不是正確的JSON格式！"]

"Messages":[""],//當(dāng)Success為false時(shí)返回空數(shù)組；

//當(dāng)Success為true時(shí)平臺(tái)返回0個(gè)、1個(gè)或多個(gè)信息字符串。如：["上傳數(shù)

據(jù)成功！"]

"Data":["73cfd5d3-7195-4f85-f63d-08d882cde193",

"ac5a260c-b01f-4589-f63e-08d882cde193"

]//當(dāng)Success為true時(shí)返回上傳的每個(gè)數(shù)據(jù)對(duì)象實(shí)例的id組成的數(shù)組；

}

8數(shù)據(jù)更新接口

調(diào)用地址：https://ip:port/data/update

調(diào)用方式：HTTP的POST方法。

調(diào)用參數(shù)：見(jiàn)表6。

表6數(shù)據(jù)更新接口調(diào)用參數(shù)

參數(shù)名類(lèi)型必填說(shuō)明舉例

"a23098ca-8584-4

tk字符串是訪(fǎng)問(wèn)令牌d76-f63b-08d882c

de193"

dataName字符串是數(shù)據(jù)對(duì)象名稱(chēng)"食品經(jīng)營(yíng)許可證"

[{

描述一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例更新的JSON"ID":"73cfd5d3-7

字符串。操作會(huì)更新ID指定的數(shù)據(jù)對(duì)象實(shí)例195-4f85-f63d-08

dataValue字符串是的相應(yīng)屬性的值。所以，每個(gè)對(duì)象實(shí)例描述d882cde193",

中必須包含ID屬性和需要更新的屬性及其"負(fù)責(zé)人":"李文才

對(duì)應(yīng)的值。"

}]

返回值：JSON對(duì)象，對(duì)象的屬性說(shuō)明和示例如下。

{

"Success":true,//請(qǐng)求的操作是否成功。調(diào)用本接口時(shí)傳遞的一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例全

部更新成功時(shí)才會(huì)返回true。

"Errors":[],//當(dāng)Success為true時(shí)返回空數(shù)組；

//當(dāng)Success為false時(shí)平臺(tái)返回1個(gè)或多個(gè)錯(cuò)誤信息字符串。如：["參數(shù)

dataValue的值不是正確的JSON格式！"]

"Messages":[""]//當(dāng)Success為false時(shí)返回空數(shù)組；

//當(dāng)Success為true時(shí)平臺(tái)返回0個(gè)、1個(gè)或多個(gè)信息字符串。如：["更新數(shù)

據(jù)成功！"]

}

9數(shù)據(jù)刪除接口

5

DB63/T2019—2022

調(diào)用地址：https://ip:port/data/delete

調(diào)用方式：HTTP的POST方法。

調(diào)用參數(shù)：見(jiàn)表7。

表7數(shù)據(jù)刪除接口調(diào)用參數(shù)

參數(shù)名類(lèi)型必填說(shuō)明舉例

"a23098ca-8584-4

tk字符串是訪(fǎng)問(wèn)令牌d76-f63b-08d882c

de193"

dataName字符串是數(shù)據(jù)對(duì)象名稱(chēng)"食品經(jīng)營(yíng)許可證"

[{

"ID":"73cfd5d3-7

195-4f85-f63d-08

描述一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例刪除的JSON

d882cde193"

字符串。操作會(huì)刪除ID指定的數(shù)據(jù)對(duì)象實(shí)

dataValue字符串是},{

例。所以，每個(gè)對(duì)象實(shí)例描述中必須包含ID

"ID":"ac5a260c-b

屬性。

01f-4589-f63e-08

d882cde193"

}]

返回值：JSON對(duì)象，對(duì)象的屬性說(shuō)明和示例如下。

{

"Success":true,//請(qǐng)求的操作是否成功。調(diào)用本接口時(shí)傳遞的一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例全

部刪除成功時(shí)才會(huì)返回true。

"Errors":[],//當(dāng)Success為true時(shí)返回空數(shù)組；

//當(dāng)Success為false時(shí)平臺(tái)返回1個(gè)或多個(gè)錯(cuò)誤信息字符串。如：["參數(shù)

dataValue的值不是正確的JSON格式！"]

"Messages":[""]//當(dāng)Success為false時(shí)返回空數(shù)組；

//當(dāng)Success為true時(shí)平臺(tái)返回0個(gè)、1個(gè)或多個(gè)信息字符串。如：["刪除數(shù)

據(jù)成功！"]

}

10數(shù)據(jù)查詢(xún)接口

調(diào)用地址：https://ip:port/data/query

調(diào)用方式：HTTP的POST方法。

調(diào)用參數(shù)：見(jiàn)表8。

6

DB63/T2019—2022

表8數(shù)據(jù)查詢(xún)接口調(diào)用參數(shù)

參數(shù)名類(lèi)型必填說(shuō)明舉例

"a23098ca-8584-4d76-f

tk字符串是訪(fǎng)問(wèn)令牌

63b-08d882cde193"

dataName字符串是數(shù)據(jù)對(duì)象名稱(chēng)"食品經(jīng)營(yíng)許可證"