DB5206T 157-2023 公共數據綜合服務平臺接口規(guī)范

ICS03.080.99DB5206Interfacespecificationofpublicdataintegratedserviceplatform銅仁市市場監(jiān)督管理局發(fā)布DB5206/T157—2023前言 Ⅱ 12規(guī)范性引用文件 13術語和定義 14縮略詞 25接口規(guī)范 2I、DB5206/T157—2023本文件按照GB/T1.1-2020《標準化工作導則第1部分：標準化文件的結構和起草規(guī)則》的規(guī)定起草。本文件由銅仁市大數據發(fā)展管理局提出并歸口管理。本文件起草單位：銅仁市大數據發(fā)展管理局、貴州梵云大數據集團有限公司、中國電信股份有限公司銅仁分公司、中國聯合網絡通信有限公司銅仁市分公司、浪潮云信息技術股份公司。本文件主要起草人：趙將、雷宏、陳丹、陳進軍、李正隆、向輝、楊志剛、牟國強、楊黔波、宋賀楠、程興章、施波、楊凡、萬嘉華、楊勝明、魯泓潁、李宗亮、桂先元、李丹、譚仁飛、陳敏、呂熹、申洋、高健東。、公共數據綜合服務平臺接口規(guī)范1范圍本文件規(guī)定了公共數據綜合服務平臺的術語和定義、縮略語、接口規(guī)范，以及實現接口的具體本文件適用于銅仁市公共數據綜合服務平臺接口的設計與開發(fā)。2規(guī)范性引用文件本文件沒有規(guī)范性引用文件。3術語和定義將應用程序的服務能力封裝成接口，并通過API網關開放給客戶端調用。銅仁市公共數據綜合服務平臺tongrenpublicdataintegratedserviceplatform資源提供方resourceproviders通過銅仁市公共數據綜合服務平臺提供資源的實體。WEB接口共享WEBinterfacesharing2DB5206/T157—2023后進行的數據交換。4縮略詞下列縮略詞適用于本文件。SOAP：簡單對象訪問協議（SimpleObjectAccessProtocol）。REST：表述性狀態(tài)傳遞（RepresentationalStateTransfer）。JSON：JS對象標記（JavaScriptObjectNotation），一種輕量級的數據交換格式。HTTPS：超文本傳輸安全協議（HyperTextTransferProtocoloverSecureSocketLayer）。Vn：版本號（VersionNumber）。5接口規(guī)范5.1接口類型5.1.1REST:REST服務消息封裝協議應采用HTTP1.0/1.1標準。5.1.2WebService:WebService服務消息封裝協議應采用SOAP1.1/1.2標準。資源提供方可以選擇其中一種方式進行開發(fā)，返回的結果都采用JSON格式。資源提供方在發(fā)布服務的時候需要注明接口的實現方式。5.2接口地址格式接口地址采用如下格式：https://ip:port/部門拼音簡寫/系統(tǒng)英文名稱/模塊英文名稱/業(yè)務操作英文名稱/版本號。部門拼音簡寫：用每個中文拼音的第一個字母。系統(tǒng)英文名稱：系統(tǒng)的英文縮寫，由服務提供者自行定義。模塊英文名稱：模塊的英文縮寫，由服務提供者自行定義。業(yè)務操作英文名稱：業(yè)務操作處理的英文縮寫，由服務提供者自行定義。版本號：用Vn進行定義。5.3接口請求方式接口請求方式應使用GET和POST。GET：如果資源需求方要獲取資源提供方的信息，采用GET請求方式。POST：如果資源需求方要提交信息給資源提供方，采用POST請求。5.4接口請求參數資源需求方在設計傳入參數時，應在Body中進行傳遞，請求參數除了業(yè)務系統(tǒng)自身規(guī)定的參數外，還需包含表1的內容。3表1請求參數類型說明請求部門名稱，用于獲知該服務被哪個部門調是字符串請求部門編碼，用于獲知該服務被哪個部門調否字符串請求程序名稱，用于獲知該服務被哪個業(yè)務程序調用。是字符串用戶名，用于安全認證，如果業(yè)務系統(tǒng)對安全有要求，可以讓資源需求方提供認證信息，通過認證后返回業(yè)務數否字符串以讓資源需求方提供認證信息，通過認證后返回業(yè)務數據。否字符串當前頁(分頁參數),需要獲取分頁數據的時候使用，如果不是分頁數據，可以不提供。如果是分頁數據，默認為否每頁記錄數(分頁參數),需要獲取分頁數據的時候使用，否通過申請獲取私人秘鑰。是字符串5.5接口應答內容接口成功接到請求，應返回狀態(tài)碼，并采用如下數據格式封裝：Code:執(zhí)行結果代碼，0為成功，其他為失敗，其他