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

ICS01.080.30CCSL4青海省地DB63方標(biāo)準(zhǔn)DB/T2019—2022青海省市場(chǎng)監(jiān)督管理局發(fā)布IDBT9—2022 1 DBT19—2022前言省市場(chǎng)監(jiān)督管理局提出并歸口。起草單位：青海省市場(chǎng)監(jiān)督管理局信息中心。偉、劉宇靜、海省市場(chǎng)監(jiān)督管理局監(jiān)督實(shí)施。1DBT19—2022市場(chǎng)監(jiān)管大數(shù)據(jù)平臺(tái)接口規(guī)范。本文件適用于市場(chǎng)監(jiān)管業(yè)務(wù)系統(tǒng)和其它信息系統(tǒng)與市場(chǎng)監(jiān)管大數(shù)據(jù)平臺(tái)之間通過接口進(jìn)行數(shù)據(jù)共范性引用文件性引用文件。定義件。息交換時(shí)通信雙方需要遵從的通信方式和要求?？蛻舳吮仨毠餐裱囊唤M約定。4縮略語HTTPSHyperTextTransferProtocoloverSecureSocketLayer)JSONJavaScript言(JavaScriptObjectNotation)RESTfulREST絡(luò)接口接口總體要求5.1接口方式統(tǒng)一采用RESTful架構(gòu)風(fēng)格的Web服務(wù)。HTTPS協(xié)議的GET和POST方式。2DBT19—20225.2接口返回?cái)?shù)據(jù)格式回?cái)?shù)據(jù)采用JSON格式。詳見每個(gè)接口的詳細(xì)描述。5.3接口調(diào)用地址本規(guī)范接口調(diào)用地址中的“https://ip:port”在實(shí)際調(diào)用時(shí)，需要把其中的“ip”和“port”修提供的真實(shí)IP地址和訪問端口。5.4部分接口調(diào)用參數(shù)說明申請(qǐng)。如：“食品從業(yè)人員信息”、“藥品零售企業(yè)信息”等。dataValue：描述一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例的JSON字符串。該JSON字符串包含一個(gè)數(shù)組對(duì)象，每個(gè)數(shù)據(jù)對(duì)象實(shí)例。如：",身份認(rèn)證接口獲取授權(quán)碼接口https/ip:port/OAuth/AuthorizeHTTPGET碼接口調(diào)用參數(shù)client_id是應(yīng)用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_idefb-4cfcd82ctsecret是用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_secret是請(qǐng)求的屬性irecturi是對(duì)應(yīng)用授權(quán)后跳轉(zhuǎn)的地以得到grant_code授權(quán)碼pportllbackresponsetype是值固定為“code”JSON，對(duì)象的屬性說明和示例如下。{grantcode/獲取到的授權(quán)碼}獲取訪問令牌接口httpsip:port/OAuth/Access_Token3DBT9—2022HTTPGET令牌接口調(diào)用參數(shù)client_id是應(yīng)用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_idefb-4cfcd82ctsecret是用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_secret是請(qǐng)求的屬性irecturi是對(duì)應(yīng)用授權(quán)后跳轉(zhuǎn)的地址pportllbackttype是值固定為“authorization_code”"authorization_c是接口”獲取到的授權(quán)碼JSON，對(duì)象的屬性說明和示例如下。{"expires_in":7200,//令牌有效期，單位“秒”tokentypeBearer獲得的令牌類型為"Bearer"accesstokenaca584-4d76-f63b-08d882cde193"http://訪問令牌}刷新令牌接口https/ip:port/OAuth/Refresh_TokenHTTPGET接口調(diào)用參數(shù)client_id是應(yīng)用向大數(shù)據(jù)平臺(tái)申請(qǐng)的client_idefb-4cfcd82cesstoken是aca-4dfbd82cJSON，對(duì)象的屬性說明和示例如下。{"expires_in":7200,//令牌有效期，單位“秒”tokentypeBearer獲得的令牌類型為"Bearer"accesstokenee47-4307-b8a0-08d840293f1a"http://新的訪問令牌}退出登錄接口4DBT19—2022https/ip:port/OAuth/LogoutHTTPGET接口調(diào)用參數(shù)是aca-4dfbd82cirecturi是地址pportme跳轉(zhuǎn)redirect_uri指定的地址。傳接口httpsip:port/data/addHTTPPOST。接口調(diào)用參數(shù)是aca-4dfbd82c是是個(gè)數(shù)據(jù)對(duì)象實(shí)例的JSON字符串""JSON，對(duì)象的屬性說明和示例如下。{Successtrue,//請(qǐng)求的操作是否成功。調(diào)用本接口時(shí)傳遞的一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例全trueErrors當(dāng)Success為true時(shí)返回空數(shù)組；5DBT19—2022//當(dāng)Success為false時(shí)平臺(tái)返回1個(gè)或多個(gè)錯(cuò)誤信息字符串。如：["參數(shù)dataValue正確的JSON格式！"]Messages當(dāng)Success為false時(shí)返回空數(shù)組；ue據(jù)成功！"]Data["73cfd5d3-7195-4f85-f63d-08d882cde193",acacbf9-f63e-08d882cde193"Successtrue回上傳的每個(gè)數(shù)據(jù)對(duì)象實(shí)例的id組成的數(shù)組；}數(shù)據(jù)更新接口httpsip:port/data/updateHTTPPOST。接口調(diào)用參數(shù)是aca-4dfbd82c是是個(gè)數(shù)據(jù)對(duì)象實(shí)例更新的JSONID的數(shù)據(jù)對(duì)象實(shí)例每個(gè)對(duì)象實(shí)例描述ID":"73cfd5d3-7cde"JSON，對(duì)象的屬性說明和示例如下。{Successtrue,//請(qǐng)求的操作是否成功。調(diào)用本接口時(shí)傳遞的一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例全trueErrors當(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ù)組；ue據(jù)成功！"]}9數(shù)據(jù)刪除接口6DBT19—2022https/ip:port/data/deleteHTTPPOST。接口調(diào)用參數(shù)是aca-4dfbd82c是是個(gè)數(shù)據(jù)對(duì)象實(shí)例刪除的JSON除ID指定的數(shù)據(jù)對(duì)象實(shí)實(shí)例描述中必須包含IDID":"73cfd5d3-7deacacbf-f63e-08deJSON，對(duì)象的屬性說明和示例如下。{Successtrue,//請(qǐng)求的操作是否成功。調(diào)用本接口時(shí)傳遞的一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例全trueErrors當(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ù)組；ue據(jù)成功！"]}httpsip:port/data/queryHTTPPOST。7DBT19—2022接口調(diào)用參數(shù)是a23098ca-8584-4d76-fbd2cde193"是是對(duì)象實(shí)例查詢的JSON查詢ID指定的數(shù)以，每個(gè)對(duì)象實(shí)例描含ID屬性。IDcfdd95-4ffdd882cde193"IDacacbf-4fed882cde193"JSON，對(duì)象的屬性說明和示例如下。{Successtrue,//請(qǐng)求的操作是否成功。調(diào)用本接口時(shí)傳遞的一個(gè)或多個(gè)數(shù)據(jù)對(duì)象實(shí)例全trueErrors當(dāng)Success為true時(shí)返回空數(shù)組；//當(dāng)Success為false時(shí)平臺(tái)返回1個(gè)或多個(gè)錯(cuò)誤信息字符串