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

公共數(shù)據(jù)綜合服務(wù)平臺接口規(guī)范目 次前言 Ⅱ范圍 1規(guī)范性引用文件 1術(shù)語和定義 1縮略詞 2接口規(guī)范 2I、PAGEPAGE1DB5206/T157—2023公共數(shù)據(jù)綜合服務(wù)平臺接口規(guī)范范圍本文件規(guī)定了公共數(shù)據(jù)綜合服務(wù)平臺的術(shù)語和定義、縮略語、接口規(guī)范，以及實現(xiàn)接口的具體要求。本文件適用于銅仁市公共數(shù)據(jù)綜合服務(wù)平臺接口的設(shè)計與開發(fā)。規(guī)范性引用文件本文件沒有規(guī)范性引用文件。術(shù)語和定義下列術(shù)語和定義適用于本文件。接口 interface將應(yīng)用程序的服務(wù)能力封裝成接口，并通過API網(wǎng)關(guān)開放給客戶端調(diào)用。銅仁市公共數(shù)據(jù)綜合服務(wù)平臺 tongrenpublicdataintegratedserviceplatform為全市數(shù)據(jù)提供共享交換的服務(wù)平臺。資源提供方 resourceproviders通過銅仁市公共數(shù)據(jù)綜合服務(wù)平臺提供資源的實體。資源需求方 resourcedemanders通過銅仁市公共數(shù)據(jù)綜合服務(wù)平臺獲取資源的實體。WEB接口共享 WEBinterfacesharing通過WEB接口方式進行數(shù)據(jù)共享，經(jīng)直接封裝或前置機封裝，通過目錄中心和交換中心發(fā)布成功后進行的數(shù)據(jù)交換?？s略詞下列縮略詞適用于本文件。SOAP：簡單對象訪問協(xié)議（SimpleObjectAccessProtocol）。REST：表述性狀態(tài)傳遞（RepresentationalStateTransfer）。JSON：JS對象標記（JavaScriptObjectNotation），一種輕量級的數(shù)據(jù)交換格式。HTTPS：超文本傳輸安全協(xié)議（HyperTextTransferProtocoloverSecureSocketLayer）。Vn：版本號（VersionNumber）。接口規(guī)范接口類型REST:REST服務(wù)消息封裝協(xié)議應(yīng)采用HTTP1.0/1.1標準。WebService:WebService服務(wù)消息封裝協(xié)議應(yīng)采用SOAP1.1/1.2標準。資源提供方可以選擇其中一種方式進行開發(fā)，返回的結(jié)果都采用JSON格式。資源提供方在發(fā)布服務(wù)的時候需要注明接口的實現(xiàn)方式。接口地址格式接口地址采用如下格式：https://ip:port/部門拼音簡寫/系統(tǒng)英文名稱/模塊英文名稱/業(yè)務(wù)操作英文名稱/版本號。部門拼音簡寫：用每個中文拼音的第一個字母。系統(tǒng)英文名稱：系統(tǒng)的英文縮寫，由服務(wù)提供者自行定義。模塊英文名稱：模塊的英文縮寫，由服務(wù)提供者自行定義。業(yè)務(wù)操作英文名稱：業(yè)務(wù)操作處理的英文縮寫，由服務(wù)提供者自行定義。版本號：用Vn進行定義。接口請求方式接口請求方式應(yīng)使用GET和POST。GET：如果資源需求方要獲取資源提供方的信息，采用GET請求方式。POST：如果資源需求方要提交信息給資源提供方，采用POST請求。接口請求參數(shù)資源需求方在設(shè)計傳入?yún)?shù)時，應(yīng)在Body中進行傳遞，請求參數(shù)除了業(yè)務(wù)系統(tǒng)自身規(guī)定的參數(shù)外，還需包含表1的內(nèi)容。表1 請求參數(shù)類型請求參數(shù)說明是必否須類型deptName請求部門名稱，用于獲知該服務(wù)被哪個部門調(diào)用。是字符串deptCode請求部門編碼，用于獲知該服務(wù)被哪個部門調(diào)用。否字符串programName請求程序名稱，用于獲知該服務(wù)被哪個業(yè)務(wù)程序調(diào)用。是字符串userName用戶名，用于安全認證，如果業(yè)務(wù)系統(tǒng)對安全有要求，可以讓資源需求方提供認證信息，通過認證后返回業(yè)務(wù)數(shù)據(jù)。否字符串password用戶密碼，用于安全認證，如果業(yè)務(wù)系統(tǒng)對安全有要求，可以讓資源需求方提供認證信息，通過認證后返回業(yè)務(wù)數(shù)據(jù)。否字符串pageNo當前頁（分頁參數(shù)），需要獲取分頁數(shù)據(jù)的時候使用，如果不是分頁數(shù)據(jù)，可以不提供。如果是分頁數(shù)據(jù)，默認為1。否數(shù)字pageSize每頁記錄數(shù)（分頁參數(shù)），需要獲取分頁數(shù)據(jù)的時候使用，如果不是分頁數(shù)據(jù)，可以不提供。如果是分頁數(shù)據(jù)，默認為10。否數(shù)字AppKey通過申請獲取私人秘鑰。是字符串接口應(yīng)答內(nèi)容接口成功接到請求，應(yīng)