DB52T 1541.4-2021 政務(wù)數(shù)據(jù)平臺(tái) 第4部分：接口規(guī)范

ICS01.040.03DB52貴州省市場(chǎng)監(jiān)督管理局發(fā)布IDB52/T1541.4—2021 12規(guī)范性引用文件 13術(shù)語(yǔ)和定義 14縮略語(yǔ) 25基本要求 26接口組成 27接口要求 38接口安全 9附錄A（資料性）認(rèn)證授權(quán)服務(wù)接口JSONSchema示例 附錄B（資料性）組織新增接口JSONSchema示例 附錄C（資料性）用戶新增接口JSONSchema示例 附錄D（資料性）數(shù)據(jù)資源目錄接口的接口信息JSONSchema示例 附錄E（資料性）數(shù)據(jù)資源目錄接口信息描述對(duì)象參數(shù)表 附錄F（資料性）數(shù)據(jù)資源目錄接口的目錄信息JSONSchema描述示例 附錄G（資料性）數(shù)據(jù)資源目錄描述對(duì)象參數(shù)表 附錄H（資料性）政務(wù)數(shù)據(jù)平臺(tái)接口返回JSONSchema示例 附錄I（資料性）政務(wù)數(shù)據(jù)平臺(tái)接口返回參數(shù)表 本文件按照GB/T1.1-2020《標(biāo)準(zhǔn)化工作導(dǎo)則第1部分：標(biāo)準(zhǔn)化文件的結(jié)構(gòu)和起草規(guī)則》州省信息中心、貴州省量子信息和大數(shù)據(jù)應(yīng)用技術(shù)研究院。本文件主要起草人：朱小洪、宿睿智、劉彥嘉、王嘉卉、徐凱琳、田野、秦曉東、邵建平、潘偉杰、韓朱旸、馮丹妮、尚志剛、楊昶、李怡然、吳明婭、石睿、曾映菊、唐昶、張洋、姚茂峰、陸瑩、孫瑾。1政務(wù)數(shù)據(jù)資源目錄directory通過(guò)對(duì)政務(wù)數(shù)據(jù)資源依據(jù)規(guī)范的元數(shù)據(jù)描述，按照一定的分類方法進(jìn)行排序和編碼的一組信息,用政務(wù)數(shù)據(jù)提供方governmentdatap2API:應(yīng)用程序編程接口(Applicatio曹善遭曹善遭認(rèn)證提權(quán)陽(yáng)芳新增接數(shù)據(jù)資源目錄0用戶接口組織接口03DB52/T1541.4—20217接口要求7.1認(rèn)證授權(quán)服務(wù)接口接口描述：政務(wù)數(shù)據(jù)提供方接入政務(wù)數(shù)據(jù)平臺(tái)應(yīng)調(diào)用認(rèn)證授權(quán)服務(wù)接口。通過(guò)平臺(tái)認(rèn)證授權(quán)服務(wù)接口進(jìn)行身份驗(yàn)證，驗(yàn)證成功后接口返回的授權(quán)訪問(wèn)令牌，政務(wù)數(shù)據(jù)提供方操作政務(wù)數(shù)據(jù)平臺(tái)接口應(yīng)攜帶訪問(wèn)令牌，進(jìn)行正常會(huì)話交互。接口地址：/api/auth_service。接口類型：post。請(qǐng)求參數(shù)：認(rèn)證授權(quán)服務(wù)接口請(qǐng)求參數(shù)見(jiàn)表1。請(qǐng)求示例：見(jiàn)附錄A。返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表1認(rèn)證授權(quán)服務(wù)接口請(qǐng)求參數(shù)表是是是是7.2組織接口7.2.1組織新增接口接口描述：政務(wù)數(shù)據(jù)提供方調(diào)用政務(wù)數(shù)據(jù)平臺(tái)組織新增接口，獲取政務(wù)數(shù)據(jù)平臺(tái)返回的組織ID，根據(jù)組織ID進(jìn)行政務(wù)數(shù)據(jù)提供方系統(tǒng)和政務(wù)數(shù)據(jù)平臺(tái)交互。接口地址：/api/add/organization。接口類型：post。請(qǐng)求參數(shù)：同步組織機(jī)構(gòu)請(qǐng)求參數(shù)見(jiàn)表2。請(qǐng)求示例：見(jiàn)附錄B。返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表2同步組織機(jī)構(gòu)請(qǐng)求參數(shù)表是是是是是是是是4DB52/T1541.4—20217.2.2組織編輯接口接口描述：編輯組織機(jī)構(gòu)信息。接口地址：/api/add/organization。接口類型：post。請(qǐng)求參數(shù)：組織機(jī)構(gòu)編輯請(qǐng)求參數(shù)見(jiàn)表3。請(qǐng)求示例：見(jiàn)附錄B。返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表3組織機(jī)構(gòu)編輯請(qǐng)求參數(shù)表是是是是是是是是7.2.3組織查詢接口接口描述：政務(wù)數(shù)據(jù)提供方查詢政務(wù)組織機(jī)構(gòu)信息。接口地址：/api/organization/query。接口類型：get。請(qǐng)求參數(shù)：組織機(jī)構(gòu)查詢接口請(qǐng)求參數(shù)見(jiàn)表4。請(qǐng)求示例：http://ip+port/api/organization/query?org_name=組織名稱&org_id=z6lqTzG3PTPpQIE92Bs0pA3PSyVJmlWM。返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表4組織機(jī)構(gòu)查詢接口請(qǐng)求參數(shù)表是是7.3用戶接口7.3.1用戶新增接口接口描述：政務(wù)數(shù)據(jù)提供方調(diào)用用戶新增接口，同步組織機(jī)構(gòu)用戶信息到政務(wù)數(shù)據(jù)平臺(tái)。接口地址：/api/add/user。接口類型：post。請(qǐng)求參數(shù)：組織機(jī)構(gòu)用戶新增請(qǐng)求參數(shù)見(jiàn)表5。5DB52/T1541.4—2021請(qǐng)求示例：見(jiàn)附錄C。返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表5組織機(jī)構(gòu)用戶新增請(qǐng)求參數(shù)表是是是是否是7.3.2用戶編輯接口接口描述：政務(wù)數(shù)據(jù)提供方編輯政務(wù)組織機(jī)構(gòu)用戶信息。接口地址：/api/add/user。接口類型：post。請(qǐng)求參數(shù)：組織機(jī)構(gòu)用戶編輯請(qǐng)求參數(shù)見(jiàn)表6。請(qǐng)求示例：見(jiàn)附錄C。返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表6組織機(jī)構(gòu)用戶編輯請(qǐng)求參數(shù)表是是是是是7.3.3用戶查詢接口接口描述：政務(wù)數(shù)據(jù)提供方查詢政務(wù)數(shù)據(jù)平臺(tái)組織機(jī)構(gòu)用戶信息。接口地址：/api/query/user。接口類型：get。請(qǐng)求參數(shù)：用戶查詢見(jiàn)請(qǐng)求參數(shù)表7。請(qǐng)求示例：http://ip+port/api/user/query?userId=z6lqTzG3PTPpQIE92Bs0pA3PSyVJmlWM。返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表7用戶查詢請(qǐng)求參數(shù)表是6DB52/T1541.4—20217.4數(shù)據(jù)資源目錄接口7.4.1數(shù)據(jù)資源目錄新增接口接口描述：政務(wù)數(shù)據(jù)提供方同步政務(wù)組織機(jī)構(gòu)的數(shù)據(jù)資源目錄信息到政務(wù)數(shù)據(jù)平臺(tái)。接口地址：/api/add/resource。接口類型：post請(qǐng)求參數(shù)：數(shù)據(jù)資源目錄新增請(qǐng)求參數(shù)見(jiàn)表8。請(qǐng)求示例：見(jiàn)附錄D。返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表8數(shù)據(jù)資源目錄新增請(qǐng)求參數(shù)表是是是是是是是是是是開(kāi)放屬性：1有條件開(kāi)放；2無(wú)條件開(kāi)是是共享屬性：1有條件共享；2無(wú)條件共享；是是78說(shuō)明是是是是是9DB52/T1541.4—2021返回參數(shù)：見(jiàn)附錄I表I.1。返回示例：見(jiàn)附錄H。表10數(shù)據(jù)資源目錄查詢請(qǐng)求參數(shù)表是是8接口安全8.1對(duì)請(qǐng)求的合法性進(jìn)行校驗(yàn)。8.2對(duì)請(qǐng)求的數(shù)據(jù)進(jìn)行校驗(yàn)。8.3對(duì)請(qǐng)求實(shí)現(xiàn)黑明單與白名單攔截。8.4對(duì)請(qǐng)求實(shí)現(xiàn)用戶使用接口的流量限制。DB52/T1541.4—2021（資料性）認(rèn)證授權(quán)服務(wù)接口JSONSchema示例下面給出認(rèn)證授權(quán)服務(wù)接口JSONSchema示例。{"$schema":"/draf"$id":"/ex{"app_key":"C3kFcJP5Pw5w13nBX2GCh0"app_secret":"rmnnkSkWfx0A7w6n13bK}"password"}DB52/T1541.4—2021（資料性）組織新增接口JSONSchema示例下面給出組織新增接口JSONSchema示例。{"$schema":"/draf"$id":"/ex"description":"Ther{"trustNo":"91370200"orgPostNo":"KXRay9t}}DB52/T1541.4—2021（資料性）用戶新增接口JSONSchema示例下面給出用戶新增接口JSONSchema示例。{"$schema":"/draft"$id":"/ex"description":"Ther{"mobile":"KXRay9teJN0V93kvgk""mobile"}DB52/T1541.4—2021（資料性）數(shù)據(jù)資源目錄接口的接口信息JSONSchema示例數(shù)據(jù)資源目錄接口的接口信息JSONSchema示例。{"$schema":"/draf"$id":"/ex"description":"Ther{"requestDemo":"?pageIndex=1&{}{DB52/T1541.4—2021}{}}DB52/T1541.4—2021（資料性）數(shù)據(jù)資源目錄接口信息描述對(duì)象參數(shù)表數(shù)據(jù)資源目錄接口信息描述對(duì)象參數(shù)表見(jiàn)表E.1。表E.1數(shù)據(jù)資源目錄接口信息描述對(duì)象參數(shù)表是是是是是是是是是是是是DB52/T1541.4—2021（資料性）數(shù)據(jù)資源目錄接口的目錄信息JSONSchema描述示例下面給出數(shù)據(jù)資源目錄接口的目錄信息JSONSchema描述示例。{"$schema":"/draf"$id":"/e"description":"Therootschema"description":"Anexpla{{"type":"varchar""systemId":"710b8d8c-e868-4b55-9e4d}DB52/T1541.4—2021}}DB52/T1541.4—2021（資料性）數(shù)據(jù)資源目錄描述對(duì)象參數(shù)表數(shù)據(jù)資源接口描述對(duì)象參數(shù)表見(jiàn)表G.1。表G.1數(shù)據(jù)資源目錄描述對(duì)象參數(shù)表是是是DB52/T1541.4—2021（資料性）政務(wù)數(shù)據(jù)平臺(tái)接口返回JSONSchema示例下面給出政務(wù)數(shù)據(jù)平臺(tái)