1肉品溯源數據接口規范本文件規定了調用肉品（批發）溯源系統的數據接口進行數據交換的接口方法和調用說明。本文件適用于調用肉品（批發）溯源系統的數據接口的集成開發。2規范性引用文件本文件沒有規范性引用文件。3術語和定義下列術語和定義適用于本文件。3.1數據接口datainterface以電子文件的形式實現，計算機軟件系統之間傳送數據、交換信息的接口。[來源：GB/T42940—2023,3.3]3.2數據對接方datadockingparty數據接口調用者，與肉品（批發）溯源系統進行數據交換的單位。4縮略語下列縮略語適用于本文件。API：應用程序編程接口（ApplicationProgrammingInterface）HTTP：超文本傳輸協議（HyperTextTransferProtocol）JSON：對象簡譜（JavascriptObjectNotation）5接口方法及調用說明5.1接口傳輸要求及對接流程5.1.1接口使用JSON傳輸數據，技術接口對接示意如圖1所示。肉品數據對接方系統獲取訪問令牌，訪問驗證通過后，根據預先定義好的接口方法，進行肉品溯源數據交換，數據接口應用示例見附錄A。5.1.2數據交換分為三種方式：a)數據對接方系統輸入參數，同步肉品溯源數據后，肉品（批發）溯源系統（以下簡稱“溯源系統”）自動實時返回溯源數據同步結果；b)數據對接方系統主動進行動檢證核驗結果查詢；2c)數據對接方系統輸入參數，同步肉品溯源數據后，溯源系統自動實時返回溯源數據同步結果和動檢證核驗結果。圖1技術接口對接示意圖5.2數據類型數據接口應支持的數據類型包括:a)字符型；b)整數型；c)浮點型；f)對象型。35.3數據接口5.3.1憑據Token調用接口接口說明接口說明如下：a)接口名稱：接口訪問授權調用接口；b)接口描述：用于獲取業務接口的訪問調用憑據；c)HTTP請求方式：GET；d)接口標識符：GetToken。接口輸入參數及說明憑據Token調用接口的輸入參數及說明見表1。表1憑據Token調用接口的輸入參數及說明是是接口返回參數及說明憑據Token調用接口的返回參數及說明見表2。表2憑據Token調用接口的返回參數及說明是是是成功則返回代碼“0”；失敗則返回錯誤碼“500”是授權訪問令牌Token是5.3.2同步肉品溯源數據的調用接口接口說明接口說明如下：a)接口名稱：同步肉品溯源數據的調用接口；b)接口描述：用于同步數據對接方系統的肉品溯源數據；c)HTTP請求方式：POST；d）接口標識符：ImportData。接口輸入參數及說明同步肉品溯源數據調用接口的輸入參數及說明見表3。4表3同步肉品溯源數據調用接口的輸入參數及說明是是否是是產品分類編碼，由“動物代碼+產品代碼+產品類型代碼”組成，例如商品豬胴體中溫肉分類編碼為1010610110102，動物代碼、產品代碼、產品類型代碼分別見附錄B、附錄C及附錄D否是批次編碼，批次唯一標識，可用“檢疫合格證否是否否是是批次進貨單價，單價的單位為“元/KG”或“元/G”是是/(KG,G)”是是否否否是否否否是是是是是是否5表3同步肉品溯源數據調用接口的輸入參數及說明（續）空否否否否否否否否否否否接口返回參數及說明同步肉品溯源數據調用接口的返回參數及說明見表4。表4同步肉品溯源數據調用接口的返回參數及說明是是是成功則返回代碼“0”；失敗則返回錯誤碼“500”是是5.3.3查詢動檢證核驗結果的調用接口接口說明接口說明如下：a）接口名稱：查詢動檢證核驗結果的調用接口；b）接口描述：用于數據對接方系統主動發起查詢動檢證在溯源系統的核驗情況；c）HTTP請求方式：POST；d）接口標識符：QueryVerifyResults。接口輸入參數及說明查詢動檢證核驗結果的調用接口的輸入參數及說明見表5。6表5查詢動檢證核驗結果調用接口的輸入參數及說明是空接口返回參數及說明查詢動檢證核驗結果的調用接口的返回參數及說明見表6。表6查詢動檢證核驗結果調用接口的返回參數及說明是是是成功則返回代碼“0”；失敗則返回錯誤碼“500”是是表7查詢動檢證核驗結果調用接口返回的結果信息參數及說明是是否是是是成功顯示“核驗通過”，失敗顯示“核驗不通過”否是是否5.3.4同步肉品溯源數據并核驗動檢證的調用接口接口說明接口說明如下：a)接口名稱：同步肉品溯源數據并核驗動檢證的調用接口；b）接口描述：用于數據對接方系統同步肉品溯源數據并返回核驗的動檢證結果，核驗結果自動實時返回；c)HTTP請求方式：POST；7d)接口標識符：ImportAndVerifyData。接口輸入參數及說明同步肉品溯源數據并核驗動檢證的調用接口輸入參數與同步肉品溯源數據的調用接口輸入參數一致（見），調用接口的輸入參數及說明見表3。接口返回參數及說明同步肉品溯源數據并核驗動檢證調用接口的返回參數及說明見表8。表8同步肉品溯源數據并核驗動檢證調用接口的返回參數及說明是是是成功則返回代碼“0”；失敗則返回錯誤碼“500”是是表9同步肉品溯源數據并核驗動檢證調用接口返回的結果信息參數及說明是是否是是是“核驗不通過”否8（資料性）數據接口應用示例A.1憑據Token接口的應用示例A.1.1接口調用的示例代碼憑據Token接口調用的示例代碼見圖A.1。OkHttpClientclient=newOkHttpClient().newBuilder().build();MediaTypemediaType=MediaType.parse("text/plain");RequestBodybody=RequestBody.create(mediaType,"");Requestrequest=newRequest.Builder().url("/mwtrace/api/api/GetToken?appId=XXX&appSecret=XXX").method("GET",body).build();Responseresponse=client.newCall(request).execute();圖A.1憑據Token接口調用的示例代碼A.1.2接口調用成功的返回示例憑據Token接口調用成功的返回示例見圖A.2。{"success":true,"message":"","code":0,"result":"XXX","timestamp":1724988940013}圖A.2憑據Token接口調用成功的返回示例A.1.3接口調用失敗的返回示例憑據Token接口調用失敗的返回示例見圖A.3。9{"success":false,"message":"XXX","code":500,"result":"XXX","timestamp":1724989006467}圖A.3憑據Token接口調用失敗的返回示例A.2同步肉品溯源數據接口的應用示例A.2.1接口調用的示例代碼同步肉品溯源數據接口調用的示例代碼見圖A.4。OkHttpClientclient=newOkHttpClient().newBuilder().build();MediaTypemediaType=MediaType.parse("application/json");RequestBodybody=RequestBody.create(mediaType,"[{\"salesDocumentNo\":\"分銷憑證編號\",\"productBarcode\":\"產品編碼\",\"productName\":\"產品名稱\",\"productCategoryCode\":\"產品分類編碼，由動物代碼+產品代碼+產品類型代碼表組成，例如商品豬胴體中溫肉分類編碼為1010610110102，詳細分類代碼見附錄\",\"productImg\":\"\",\"batchCode\":\"批次編碼，批次唯一標識，例如（檢疫合格證號+軌道號+分割流水號）\",\"batch\":\"批次\",\"batchWeight\":\"批次總重量\",\"batchUnit\":\"批次單位(KG，G，默認KG)\",\"batchInNo\":\"批次進貨單號\",\"batchInWeight\":\"批次進貨重量，\",\"batchInPrice\":\"（元/KG,元/G）\",\"batchInDate\":\"批次進貨日期\",\"batchOutPrice\":\"（元/KG,元/G）\",\"batchOutDate\":\"批次銷售日期\",\"batchOutWeight\":\"批次銷售重量\",\"batchCheckReport\":\"\",\"animalCertNo\":\"動物檢疫合格證編號\",\"animalCertType\":\"動物檢疫合格證類型（da：動物A證，db：動物B證）\",\"quarantineCertNo\":\"產品檢疫合格證編號\",\"quarantineCertType\":\"產品檢疫合格證類型（ca：產品A證，cb：產品B證）\",\"producerBaseName\":\"生產/養殖基地名稱\",圖A.4同步肉品溯源數據接口調用的示例代碼\"producerBaseAddr\":\"生產/養殖基地地址\",\"butcherEntName\":\"屠宰企業名稱\",\"butcherEntUnifCode\":\"屠宰企業統一社會信用代碼\",\"supplierEntName\":\"市場供貨企業名稱，以英文;間隔\",\"supplierEntUnifCode\":\"市場供貨企業統一社會信用代碼，多個代碼以英文;間隔\",\"flowtoEntName\":\"流向企業名稱，多個以英文;間隔\",\"flowtoEntUnifCode\":\"流向企業統一社會信用代碼，多個代碼以英文;間隔\"，\"qrcodeUrl\":\"分銷溯源二維碼網址\",\"animalCertSerial\":\"動物檢疫合格證流水號\",\"quarantineCertSerial\":\"產品檢疫合格證流水號\",\"exHz\":\"附加供貨企業，多個企業以英文;間隔\",\"exButcher\":\"附加屠宰企業，多個企業以英文;間隔\",\"exFlowto\":\"附加流向，多個流向以英文;間隔\",\"exAnimalCertUrl\":\"附加動物檢疫合格證圖片網址，多個網址以英文;間隔\",\"exQuarantineCertUrl\":\"附加產品檢疫合格證圖片網址，多個網址以英文;間隔\",\"exAnimalCertNo\":\"附加動物檢疫證編號，多個編號以英文;間隔\",\"exQuarantineCertNo\":\"附加產品檢疫證編號，多個編號以英文;間隔\",\"meatQualityNo\":\"肉品品質檢驗證編號，多個編號以英文;間隔\",\"meatQualityUrl\":\"肉品品質檢驗證網址，多個網址以英文;間隔\",\"delFlag\":\"刪除標記，默認0為不刪除，1為刪除，若僅刪除數據可只傳分銷號（salesDocumentNo）和本刪除標記\",}]");Requestrequest=newRequest.Builder().url("/mwtrace/api/api/ImportData").method("POST",body).addHeader("X-Access-Token","XXX").addHeader("Content-Type","application/json").build();Responseresponse=client.newCall(request).execute();圖A.4同步肉品溯源數據接口調用的示例代碼（續）A.2.2接口調用成功的返回示例同步肉品溯源數據接口調用成功的返回示例見圖A.5。{"success":true,"message":"第X條，數據導入成功；第X條，數據導入成功；","code":0,"result":"數據導入完成，成功X條，失敗X條","timestamp":1724989852669}圖A.5同步肉品溯源數據接口調用成功的返回示例A.2.3接口調用失敗的返回示例同步肉品溯源數據接口調用失敗的返回示例見圖A.6。{"success":false,"message":"****","code":500,"result":"****","timestamp":1724989006467}圖A.6同步肉品溯源數據接口調用失敗的返回示例A.3查詢動檢證核驗結果接口的應用示例A.3.1接口調用的示例代碼查詢動檢證核驗結果接口調用的示例代碼見圖A.7。OkHttpClientclient=newOkHttpClient().newBuilder().build();MediaTypemediaType=MediaType.parse("application/json");RequestBodybody=RequestBody.create(mediaType,"[{\"salesDocumentNo\":\"XXX\",\"batchCode\":\"XXX\",\"quarantineCertNo\":\"XXX\"}]");Requestrequest=newRequest.Builder().url("/mwtrace/api/api/QueryVerifyResults").method("POST",body).addHeader("X-Access-Token","XXX").addHeader("Content-Type","application/json").build();Responseresponse=client.newCall(request).execute();圖A.7查詢動檢證核驗結果接口調用的示例代碼A.3.2接口調用成功的返回示例查詢動檢證核驗結果接口調用成功的返回示例見圖A.8。{"success":true,"message":"","code":0,"result":"verifySlRemark":"","verifySlStatus":0,"verifyStatus":0,"verifyRemark":"","batchCode":"XXX","quarantineCertNo":"XXX","verifyResult":"核驗通過","verifySlResult":"數量核驗通過","salesDocumentNo":"XXX"}],"timestamp":1724990253246}圖A.8查詢動檢證核驗結果接口調用成功的返回示例A.3.3接口調用失敗的返回示例查詢動檢證核驗結果接口調用失敗的返回示例見圖A.9。{{"success":false,"message":"XXX","code":500,"result":"XXX","timestamp":1724989006467}圖A.9查詢動檢證核驗結果接口調用失敗的返回示例A.4同步肉品溯源數據并核驗動檢證接口的應用示例A.4.1接口調用的示例代碼同步肉品溯源數據并核驗動檢證接口調用的示例代碼見圖A.10。OkHttpClientclient=newOkHttpClient().newBuilder().build();MediaTypemediaType=MediaType.parse("application/json");RequestBodybody=RequestBody.create(mediaType,@"[{\"salesDocumentNo\":\"分銷憑證編號\",\"productBarcode\":\"產品編碼\",\"productName\":\"產品名稱\",\"productCategoryCode\":\"產品分類編碼，由動物代碼+產品代碼+產品類型代碼表組成，例如商品豬胴體中溫肉分類編碼為1010610110102，詳細分類代碼見附錄\",\"productImg\":\"產品圖片的網址，多個網址以,分隔\",\"batchCode\":\"批次編碼，批次唯一標識，例如（檢疫合格證號+軌道號+分割流水號），必填\",\"batch\":\"批次\",\"batchWeight\":\"批次總重量\",\"batchUnit\":\"批次單位(KG，G，默認KG)\",\"batchInNo\":\"批次進貨單號\",\r\n\"batchInWeight\":\"批次進貨重量\",\"batchInPrice\":\"批次進貨單價，人民幣（元/KG,元/G）\",\"batchInDate\":\"批次進貨日期\",\"batchOutPrice\":\"批次銷售單價，人民幣（元/KG,元/G）\",\"batchOutDate\":\"批次銷售日期\",\"batchOutWeight\":\"批次銷售重量\",\"batchCheckReport\":\"批次檢驗報告，產品報告圖片或文件的網址，多張圖片以英文,分隔\",\"animalCertNo\":\"動物檢疫合格證編號\",\"animalCertType\":\"動物檢疫合格證類型（da：動物A證，db：動物B證）\",\"quarantineCertNo\":\"產品檢疫合格證編號\",\"quarantineCertType\":\"產品檢疫合格證類型（ca：產品A證，cb：產品B證）\",\"producerBaseName\":\"生產/養殖基地名稱\",\"producerBaseAddr\":\"生產/養殖基地地址\",\"butcherEntName\":\"屠宰企業名稱\",圖A.10同步肉品溯源數據并核驗動檢證接口調用的示例代碼\"butcherEntUnifCode\":\"屠宰企業統一社會信用代碼\",\"supplierEntName\":\"市場供貨企業名稱，多個名稱以英文;間隔\",\"supplierEntUnifCode\":\"市場供貨企業統一社會信用代碼，多個代碼以英文;間隔\",\"flowtoEntName\":\"流向企業名稱，多個名稱以英文;間隔\",\"flowtoEntUnifCode\":\"流向企業統一社會信用代碼，多個代碼以英文;間隔\"，\"qrcodeUrl\":\"分銷溯源二維碼網址\",\"animalCertSerial\":\"動物檢疫合格證流水號\",\"quarantineCertSerial\":\"產品檢疫合格證流水號\",\"exHz\":\"附加供貨企業，多個企業以英文;間隔\",\"exButcher\":\"附加屠宰企業，多個企業以英文;間隔\",\"exFlowto\":\"附加流向，多個流向以英文;間隔\",\"exAnimalCertUrl\":\"附加動物檢疫合格證圖片網址，多個網址以英文;間隔\",\"exQuarantineCertUrl\":\"附加產品檢疫合格證圖片網址，多個網址以英文;間隔\",\"exAnimalCertNo\":\"附加動物檢疫證編號，多個編號以英文;間隔\",\"exQuarantineCertNo\":\"附加產品檢疫證編號，多個編號以英文;間隔\",\"meatQualityNo\":\"肉品品質檢驗證編號，多個編號以英文;間隔\",\"meatQualityUrl\":\"肉品品質檢驗證網址，多個網址以英文;間隔\",\"delFlag\":\"刪除標記，默認0為不刪除，1為刪除，若僅刪除數據可只傳分銷號（salesDocumentNo）和本刪除標記\",}]");Requestrequest=newRequest.Builder().url("/mwtrace