食品和食用農(nóng)產(chǎn)品追溯系統(tǒng)接口服務(wù)功能示例

食品和食用農(nóng)產(chǎn)品追溯系統(tǒng)接口服務(wù)功能示例授權(quán)接口接口地址接口地址示例：https://{域名}:{端口}/api/v1/auth。功能說明系統(tǒng)認證接口，驗證調(diào)用方的appKey和簽名，驗證通過后，返回數(shù)字令牌。參數(shù)說明提交方法(Method)：提交（Post）。請求頭(Header)：如表A.1所示。授權(quán)接口請求頭(Header)表參數(shù)名稱數(shù)據(jù)類型是否必填描述Content-TypeString是請求數(shù)據(jù)的內(nèi)容類型字符串，固定為：application/json;charset=utf-8請求參數(shù)以JSON格式消息體(Body)傳輸，如表A.2所示。授權(quán)接口請求參數(shù)表參數(shù)名稱數(shù)據(jù)類型是否必填描述appKeyString是服務(wù)端提供給調(diào)用者的憑證，用于標識服務(wù)接口調(diào)用者的身份timestampTimestamp是接口調(diào)用時間signatureString是請求簽名，用于驗證此次請求的合法性，由調(diào)用者根據(jù)實際的輸入?yún)?shù)，并憑密鑰（appSecret）和約定的簽名算法生成的簽名返回內(nèi)容類型(Content-Type)：application/json;charset=utf-8。返回數(shù)據(jù)的參數(shù)說明，如表A.3所示。授權(quán)接口返回參數(shù)表參數(shù)名稱數(shù)據(jù)類型是否必填描述successBoolean是接口調(diào)用結(jié)果，包括以下兩種結(jié)果：True=接口調(diào)用成功；False=接口調(diào)用失敗。codeNumber是接口響應(yīng)碼，見A.11表A.3授權(quán)接口返回參數(shù)表（續(xù)）參數(shù)名稱數(shù)據(jù)類型是否必填描述messageString否接口提示信息resultObject是接口調(diào)用成功后，返回的數(shù)據(jù)對象tokenString是接口調(diào)用成功后，返回的數(shù)字令牌expiredTimestamp是數(shù)字令牌的過期時間codeNumber是接口響應(yīng)碼，見A.11請求示例授權(quán)接口請求的消息示例如下所示。請求方法：PostURL：/api/v1/auth請求頭:Content-Type:application/json;charset=utf-8請求消息體：{"appKey":"ak00001","timestamp":"1711001391000","signature":"xxxxxxxxxxx"}返回示例授權(quán)接口返回的解密后的消息明文示例如下所示。{"success":true,"code":200,"result":{"token":"xxxxxxxx.xxxxxxxxxxxxxxxxxx.xxxxxxxx","expired":1711011391000}}上傳接口接口地址接口地址示例：https://{域名}:{端口}/api/v1/{數(shù)據(jù)元標識}。{數(shù)據(jù)元標識}為上傳的追溯信息數(shù)據(jù)集的唯一標識，例如product表示產(chǎn)品信息。具體可參考DB31/T1110.2。功能說明追溯信息的上傳接口。參數(shù)說明提交方法(Method)：提交（Post）。請求頭(Header)：如表A.4所示。上傳接口請求頭(Header)表參數(shù)名稱數(shù)據(jù)類型是否必填描述Content-TypeString是請求數(shù)據(jù)的內(nèi)容類型字符串，固定為：application/json;charset=utf-8AuthorizationString是調(diào)用者的認證憑據(jù)，由固定字符串"Bearer"+數(shù)字令牌字符串拼接而成請求參數(shù)以JSON格式消息體(Body)傳輸，如表A.5所示。上傳接口請求參數(shù)表參數(shù)名稱數(shù)據(jù)類型是否必填描述dataArray是按照數(shù)據(jù)元的標識和數(shù)據(jù)元的值，構(gòu)造數(shù)據(jù)元的JSON對象，并可將多條數(shù)據(jù)元JSON組合為一個Array放入該參數(shù)值中，實現(xiàn)批量上傳。返回內(nèi)容類型(Content-Type)：application/json;charset=utf-8。返回數(shù)據(jù)的參數(shù)說明，如表A.6所示。上傳接口返回參數(shù)表參數(shù)名稱數(shù)據(jù)類型是否必填描述successBoolean是接口調(diào)用結(jié)果，包括以下兩種結(jié)果：True=接口調(diào)用成功；False=接口調(diào)用失敗。codeNumber是接口響應(yīng)碼，見A.11messageString否接口提示信息請求示例上傳接口請求的消息示例如下所示。請求頭:Content-Type:application/json;charset=utf-8Authorization:Bearerxxxxxxxx.xxxxxxxxxxxxxxxxxx.xxxxxxxx請求消息體：{"data":[{"productionName":"飲料A","producerName":"生產(chǎn)廠商A","standard":"500ml","shelfLife":180,"category":"6","barcode":"6901234567892","certNo":"A12345678","certPicture":"data:application/jpeg;base64,xxxxxxxxxxxxxxxxxxxxxx"},{"productionName":"飲料B","producerName":"生產(chǎn)廠商B","standard":"500ml","shelfLife":180,"category":"6","barcode":"6911234567891","certNo":"B12345678","certPicture":"data:application/jpeg;base64,xxxxxxxxxxxxxxxxxxxxxx"}]}返回示例上傳接口返回的解密后的消息明文示例如下所示。{"success":true,"code":200}單品追溯碼查詢接口接口地址接口地址示例：https://{域名}:{端口}/api/v1/trace。功能說明根據(jù)單品追溯碼查詢追溯信息的查詢接口。參數(shù)說明提交方法(Method)：接收（Get）。請求頭(Header)：如表A.7所示。單品追溯碼查詢接口請求頭(Header)表參數(shù)名稱數(shù)據(jù)類型是否必填描述Content-TypeString是請求數(shù)據(jù)的內(nèi)容類型字符串，固定為：application/json;charset=utf-8AuthorizationString是調(diào)用者的認證憑據(jù)，由固定字符串"Bearer"+數(shù)字令牌字符串拼接而成請求參數(shù)以URL參數(shù)格式傳遞，如表A.8所示。單品追溯碼查詢接口請求參數(shù)表參數(shù)名稱數(shù)據(jù)類型是否必填描述individualCodeString是要獲取追溯信息的單品追溯碼，例如：010690123456789221000002。返回內(nèi)容類型(Content-Type)：application/json;charset=utf-8。返回數(shù)據(jù)的參數(shù)說明，如表A.9所示。單品追溯碼查詢接口返回參數(shù)表參數(shù)名稱數(shù)據(jù)類型是否必填描述successBoolean是接口調(diào)用結(jié)果，包括以下兩種結(jié)果：True=接口調(diào)用成功；False=接口調(diào)用失敗。codeNumber是接口響應(yīng)碼，見A.11messageString否接口提示信息dataObject是按照數(shù)據(jù)元的標識和數(shù)據(jù)元的值，返回該追溯碼對應(yīng)的數(shù)據(jù)元的JSON對象。請求示例單品追溯碼查詢接口請求的消息示例如下所示。請求方法：GetURL：/api/v1/trace?individualCode=010690123456789221000002請求頭:Content-Type:application/json;charset=utf-8Authorization:Bearerxxxxxxxx.xxxxxxxxxxxxxxxxxx.xxxxxxxx返回示例單品追溯碼查詢接口返回的解密后的消息明文示例如下所示。{"success":true,"code":200,data:{"product":{"productionName":"飲料A","producerName":"生產(chǎn)廠商A","standard":"500ml","shelfLife":180,"category":"6","barcode":"6901234567892","certNo":"A12345678","certPicture":"data:application/jpeg;base64,xxxxxxxxxxxxxxxxxxxxxx"},"sales":{"code":"xxxxxxxxxxxxxxxxxxxx","name":"銷售單位A","tCode":"010690123456789221000002","producer":"生產(chǎn)廠商A","productionDate":"2024-9-9","batch":"1000","quantity":123,"unit":"公斤","