DB14-T 2831-2023 商務誠信公共服務平臺信息交換接口規(guī)范

ICS03.080.99CCSA2014IDB14/T2831—2023前言 2規(guī)范性引用文件 3術語和定義 4縮略語 5接口類型 6接口服務 27技術要求 68管理要求 79持續(xù)優(yōu)化 7附錄A（資料性）接口示例 9DB14/T2831—2023本文件按照GB/T1.1—2020《標準化工作導則第1部分：標準化文件的結構和起草規(guī)則》的規(guī)定起草。本文件由山西省商務廳提出、組織實施和監(jiān)督檢查。山西省市場監(jiān)督管理局對標準的組織實施情況進行監(jiān)督檢查。本文件由山西省商貿(mào)標準化技術委員會歸口。本文件起草單位：山西省檢驗檢測中心（山西省標準計量技術研究院）、廣東德信行信用管理有限公司、山西清眾科技股份有限公司、阿里云計算有限公司、河北省商務廳新聞文化中心（河北省商務研究中心）。本文件主要起草人：邢建全、王劍、喬智敏、杜占利、方明、吳雨洲、金琳琳、郭振超、陳舒庭、胡燕華、羅軒、高志熙、王程、劉劍、陳哲、馬勇。1DB14/T2831—2023商務誠信公共服務平臺信息交換接口規(guī)范本文件規(guī)定了商務誠信公共服務平臺信息交換接口的術語和定義、接口類型、接口服務、技術要求、管理要求和持續(xù)優(yōu)化。本文件適用于商務誠信公共服務平臺與各數(shù)據(jù)提供方、數(shù)據(jù)應用方、信用場景方之間的商務誠信信息共享交換活動。2規(guī)范性引用文件下列文件中的內(nèi)容通過文中的規(guī)范性引用而構成本文件必不可少的條款。其中，注日期的引用文件，僅該日期對應的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB/T22117信用基本術語3術語和定義GB/T22117界定的以及下列術語和定義適用于本文件。3.1信息交換informationexchange信息資源在計算機網(wǎng)絡環(huán)境下從一個交換結點到其他交換結點的傳送和處理過程。3.2信息交換接口informationexchangeinterface信息交換在既定交換方式的基礎上，約定的信息交換實體，便于信息能夠交換到約定地點、信息來源能夠被識別、信息內(nèi)容能夠被理解。4縮略語下列縮略語適用于本文件。JSON：JavaScript對象標記（JavaScriptObjectNotation）API：應用程序界面（ApplicationProgramInterface）HTTP：超文本傳送協(xié)議（HyperTextTransportProtocol）5接口類型5.1數(shù)據(jù)采集類數(shù)據(jù)采集類接口用于商務誠信公共服務平臺通過地方政務大數(shù)據(jù)中心、地方公共信用信息共享平臺、信用信息數(shù)源單位業(yè)務系統(tǒng)、第三方機構業(yè)務系統(tǒng)及其他商務誠信公共服務平臺等采集數(shù)據(jù)。2DB14/T2831—20235.2數(shù)據(jù)共享類數(shù)據(jù)共享類接口用于商務誠信公共服務平臺向接入的平臺共享商務誠信信息。常見接口示例見附錄A。5.3賬號管理類賬號管理類接口用于商務誠信公共服務平臺對接入的平臺用戶賬號和權限的管理，包括獲取公鑰接口、修改用戶密碼接口、獲取令牌接口。6接口服務6.1平臺接入6.1.1接入申請申請接入商務誠信公共服務平臺的單位應制定接入方案，描述擬接入平臺的網(wǎng)絡環(huán)境、安全保障、硬件條件、接口調(diào)用方案等信息，并向商務誠信公共服務平臺運營單位提出接入申請。申請材料包括申請接入的單位證明文件、申請接入的理由、數(shù)據(jù)需求、用途、接入方案等信息。6.1.2接入審核接入方提出平臺數(shù)據(jù)接入申請后，由商務誠信公共服務平臺運營單位對申請材料及接入方案進行審核。對于符合接入條件的單位，按時做好平臺接入技術準備工作，并回復申請單位的接入申請審批結果。6.1.3備案登記商務誠信公共服務平臺運營單位需對接入平臺進行備案登記，記錄接入平臺的基本資料，包括平臺名稱、用戶編號、域名、服務器IP、運營單位名稱、聯(lián)系人姓名及聯(lián)系電話等信息。6.1.4簽訂協(xié)議由接入平臺與商務誠信公共服務平臺運營單位簽訂用戶協(xié)議，根據(jù)業(yè)務場景確定接入方式，明確需要調(diào)用的接口信息，共同約定數(shù)據(jù)共享的頻率、數(shù)據(jù)格式、交換方式、接口要求、有效期限、公開屬性等內(nèi)容。6.1.5密鑰獲取接入平臺用戶通過商務誠信公共服務平臺注冊用戶信息，經(jīng)平臺運營單位審核后，申請接口密鑰，申請通過后平臺下發(fā)接口訪問密鑰。獲取密鑰流程如圖1所示：3DB14/T2831—2023圖1獲取密鑰流程圖6.1.6對接調(diào)試接入平臺用戶使用商務誠信公共服務平臺運營單位提供的平臺賬號、接口地址，對接入服務進行雙方聯(lián)調(diào)。經(jīng)調(diào)試，實現(xiàn)接口正常調(diào)用的，即可正式上線。6.1.7交換審計為保證商務誠信信息交換過程的安全、質(zhì)量和時效，商務誠信公共服務平臺運營單位應遵循相關法律法規(guī)及國家標準、地方標準要求，對交換共享的過程進行全面記錄并進行交換審計，包括但不限于交換接入審計、信息溯源審計。6.2接口調(diào)用6.2.1數(shù)據(jù)采集類接口調(diào)用流程商務誠信公共服務平臺可通過接口調(diào)用方式從地方政務大數(shù)據(jù)中心、地方公共信用信息共享平臺、信用信息數(shù)源單位業(yè)務系統(tǒng)、第三方機構業(yè)務系統(tǒng)、其他商務誠信公共服務平臺等數(shù)據(jù)提供方平臺采集數(shù)據(jù)。接口采用HTTP通訊協(xié)議進行同步通訊，實現(xiàn)信息交換。數(shù)據(jù)接口應對數(shù)據(jù)報文進行加密處理，保障數(shù)據(jù)在傳輸過程中的安全。商務誠信公共服務平臺收到數(shù)據(jù)提供方平臺返回的數(shù)據(jù)后，進行解密操作，并對解密數(shù)據(jù)生成摘要，與數(shù)據(jù)提供方平臺生成的摘要進行比對，確保數(shù)據(jù)沒有被篡改。商務誠信公共服務平臺根據(jù)數(shù)據(jù)采集任務要求及商務誠信信息服務需要，定期或不定期發(fā)起數(shù)據(jù)采集請求，數(shù)據(jù)提供方平臺再根據(jù)接口約定與商務誠信公共服務平臺進行數(shù)據(jù)交互。數(shù)據(jù)采集類接口調(diào)用流程如圖2所示：4DB14/T2831—2023圖2數(shù)據(jù)采集類接口調(diào)用流程6.2.2一般查詢接口調(diào)用流程商務誠信公共服務平臺面向接入平臺主要通過接口調(diào)用方式提供商務誠信信息共享服務。接口支持采用webservice/http/https通訊協(xié)議進行同步通訊，實現(xiàn)信息交換。商務誠信公共服務平臺對外提供的數(shù)據(jù)接口通過用戶賬號管理機制來控制接入平臺用戶使用權限。符合接入條件、完成賬號配置的接入平臺方能發(fā)起查詢請求。商務誠信公共服務平臺再按照接口約定與接入平臺進行數(shù)據(jù)交互。數(shù)據(jù)接口應對數(shù)據(jù)報文進行加密處理，保障數(shù)據(jù)在傳輸過程中的安全。接入平臺收到商務誠信公共服務平臺返回的數(shù)據(jù)后，進行解密操作，并對解密數(shù)據(jù)生成摘要，與商務誠信公共服務平臺生成的摘要進行比對，確保數(shù)據(jù)沒有被篡改。一般查詢接口調(diào)用服務流程如圖3所示：5DB14/T2831—2023圖3一般查詢接口調(diào)用流程6.2.3授權查詢接口調(diào)用流程商務誠信公共服務平臺還可對外提供能反映商貿(mào)流通企業(yè)商務誠信水平的非公開信息。接入平臺調(diào)用此類查詢接口時，須提供對應企業(yè)的合法授權憑證，包括以下步驟：——通過商務誠信公共服務平臺提供的接口上傳企業(yè)授權協(xié)議，保存返回的授權協(xié)議標識；——調(diào)用授權查詢信息接口，文件標識作為必傳參數(shù)，經(jīng)商務誠信公共服務平臺驗證通過后，返回查詢結果。授權查詢接口調(diào)用流程如圖4所示：6DB14/T2831—2023圖4授權查詢接口調(diào)用流程7技術要求7.1接口基本規(guī)范7.1.1商務誠信公共服務平臺提供API接口服務，遵循RESTful設計風格，與接入平臺的數(shù)據(jù)交換格式采用Json格式。接口調(diào)用與返回參數(shù)可參照附錄A的接口示例。7.1.2數(shù)據(jù)采集類接口可在雙方協(xié)商一致的基礎上，遵循數(shù)據(jù)提供方平臺的接口規(guī)范要求。7DB14/T2831—20237.2系統(tǒng)級參數(shù)約定表1中系統(tǒng)級參數(shù)是由商務誠信公共服務平臺系統(tǒng)定義的，各接入平臺需要支持這些參數(shù)以便接入該平臺提供開放接口。商務誠信公共服務平臺采用應用授權認證接口方式，接入平臺調(diào)用平臺接口時需提供密鑰、賬戶和密碼。表1系統(tǒng)級參數(shù)說明是是是7.3應用級參數(shù)的通用約定各業(yè)務系統(tǒng)應遵守API平臺系統(tǒng)規(guī)范中應用級通用參數(shù)的約定。應用及參數(shù)說明見表2。表2應用級參數(shù)說明是是8管理要求8.1總體要求商務誠信公共服務平臺運營單位負責對接口的設計、開發(fā)、啟動、修改、停用、刪除進行全流程管8.2監(jiān)測檢查8.2.1商務誠信公共服務平臺運營單位對接口服務進行定期監(jiān)測，定期對問題進行匯總分析，檢查發(fā)現(xiàn)錯誤或問題及時處理，必要時向接入平臺用戶協(xié)商確定解決方案。8.2.2監(jiān)測檢查的內(nèi)容包括：——更新頻率，按照相關協(xié)議檢查平臺是否與外部系統(tǒng)進行數(shù)據(jù)共享；——數(shù)據(jù)質(zhì)量，商務誠信公共服務平臺運營單位每月不低于一次監(jiān)測數(shù)據(jù)質(zhì)量，包括提供的數(shù)據(jù)是否根據(jù)協(xié)議規(guī)定采集、共享；數(shù)據(jù)格式是否規(guī)范；數(shù)據(jù)內(nèi)容是否完整；數(shù)據(jù)是否準確真實8.3安全控制商務誠信公共服務平臺運營單位應從技術和管理兩個方面加強系統(tǒng)安全和數(shù)據(jù)安全，實施嚴格的用戶認證和權限控制策略，滿足對信息安全保護及信息保密需求。9持續(xù)優(yōu)化8DB14/T2831—2023商務誠信公共服務平臺運營單位應根據(jù)平臺發(fā)展定位及服務需求，結合接口調(diào)用實際情況，定期優(yōu)化調(diào)整平臺接口規(guī)劃，提升接口性能及接口數(shù)據(jù)質(zhì)量，適應商務誠信公共服務平臺及各相關平臺對商務誠信信息共享及應用要求。9DB14/T2831—2023接口示例A.1獲取單個企業(yè)誠信等級接口根據(jù)統(tǒng)一社會信用代碼獲取企業(yè)的誠信等級，誠信等級分為5個級別，分別為AA，A，B，C，D?！涌跇俗R：getEnterpriseGrade；——請求方式：POST；——請求參數(shù)如表A.1所示，返回參數(shù)如表A.2所示。表A.1獲取單個企業(yè)誠信等級接口請求參數(shù)說明是是是是表A.2獲取單個企業(yè)誠信等級接口返回參數(shù)說明{msg:’獲取企業(yè)誠信等級成功’,data:{uniscId:’91140107×××××××6F’,assessGrade:‘A’}A.2批量獲取企業(yè)誠信等級接口批量獲取企業(yè)的誠信等級，根據(jù)參數(shù)當前頁碼和頁碼的大小獲取?！涌跇俗R：getEnterpriseGrades——請求方式：POST——請求參數(shù)如表A.3所示，返回參數(shù)如表A.4所示：DB14/T2831—2023表A.3批量獲取企業(yè)誠信等級接口請求參數(shù)說明是是是是是表A.4批量獲取企業(yè)誠信等級接口返回參數(shù)說明{msg:’獲取企業(yè)誠信等級成功’,data:{pageno:10,count:1700000,pagesize:1000,companyList:[{uniscId:’92140107××××××1J’,assessGrade:‘A’{uniscId:’92140107××××××1K’,assessGrade:‘B’………,{uniscId:’92140107×××××××56’,assessGrade:‘AA’]DB14/T2831—2023}A.3授權獲取公共資源交易記錄接口以公共資源交易記錄查詢接口為例，對接口文檔進行說明。根據(jù)組織機構統(tǒng)一社會信用代碼獲取企業(yè)的公共資源交