长三角食品安全信息平台追溯数据接口JSON格式数据示例.docx
附录A长三角食品安全信息平台追溯数据接口JSON格式数据示例A.1接口地址接口地址由请求的URL地址,一般由域名或IP、端口号、接口路径组成。示例:https:域名:端口apitraceA.2功能说明追溯信息查询的服务接口。根据请求调用返回某个追溯码对应的追溯信息。A.3参数说明提交方法(MethOd) : Geto,.3.2 请求头(Header):如表Al所示。表A.1请求头(Header)表参数名称数据类型是否必填描述appKeyString是服务端提供给调用者的凭证,用于标识服务接口调用者的身份timestampDateTime是接II调用时间,采用YYYY-MM-DDThh:mm:ss的格式转化为字符串传输signatureString是请求签名,用于验证此次请求的合法性,由调用者根据实际的输入参数,并凭密钥(appSecret)和约定的签名算法生成的签名A.3.3请求参数以URL参数格式传输,如表A.2所示。表A.2请求参数表参数名称数据类型是否必填描述traceCodeString是追溯码pageInteger否请求数据的当前页码,用于支持数组数据分页,默认为第1页sizeInteger否请求数据的每页条数,用于支持数组数据分页,默认为20条A.3.4返回内容类型(COntent-TyPe):appIication/json;CharSet=Utf-8。A.3.5返回数据的参数说明,如表A.3所示。表A.3返回参数表参数名称数据类型是否必填描述successBoolean是接口调用结果,包括以卜两种结果:TrUe=接1调用成功;FaISe=接口调用失败。codeNumber是接口响应码,见A.6messageString否接口提示信息totalInteger是查询到的数据总条数,可用于支持数组数据分页pageInteger是返回数据的当前页码sizeInteger是返回数据的条数表A.3返回参数表(续)参数名称数据类型是否必填描述resultArray是接口调用成功后,返回的追溯数据的数据集enterpriseObject是接11调用成功后,返回的食品和食用农产品生产经营者信息对象,对象中的参数应符合DB31T310XX.2中第6章的规定productObject否追溯信息中的食品和食用农产品基础信息对象,对象中的参数应符合DB31T310XX.2中第7章的规定productionObject否追溯信息中的食品和食用农产品生产信息对象的数组,对象中的参数应符合DB31T310XX.2中第8章的规定circulationArray否追溯信息中的食品和食用农产品流通信息对象的数组,流通信息对象中的参数应符合DB31/T3IOXX.2中第9章的规定inspectionArray否追溯信息中的食品和食用农产品抽检信息对象的数组,抽检信息对象中的参数应符合DB31/T3IOXX.2中第10章的规定A.4请求示例请求的消息示例参见表A.4。表A.4请求的消息示例请求方法:GetURL:https:/www.mydomain,com/api/trace?traceCode-010690123456789910999999请求头:appKey:ak00001timestamp:2023-05-31TO9:09:09signature:xxxxxxxxxxxA.5返回示例返回的解密后的消息明文示例参见A.5。表A.5返回消息代码示例表1“success”:true,"code”:200,“total”:200,page:1,"size”:20,“result”:(“enterprise”:z,enterpriseNamez,:“上海市XXXX有限公司”,*enterpriSeTrademarkw:“上海xxx”,“enterpriseType":"0","uniSCIDw,91310000000000000000,“iicNo"Jyoooooooooooooozx,*certPicture:,data:application/jpeg;base64,dk8234klj0ksjdfkl23iosdf=",表A.5返回消息代码示例表(续)“certEffectiVeDate":"2020-01-01”,*certExpiryDate*:*2030-01-01*,“IegalRepresentative":"张xx",“supervisoryAgency":"XXX街道市场监管所”,“scope":"食品生产、销售,"address":"黄浦区XXX路XXX号”,*contactPerson*:“张xx”,“contactPhone":"13900000000”,“IegalPersonType":"0",*establishmentDatez,:2020-01-01,*businessLicensePicture/!,:z,data:application/jpeg;base64,dk8234klj0ksjdfkl23iosdf=9“registeredAddress":"黄浦区XXX路XXX号”,"regiStrationAuthority":"黄浦区市场监督管理局”,“businessVodel":"生产、批发“,zzCertificateStatus*:*!*),“product”:"productionName":"饮料A”,yzProducerNamezz:"生产厂商A”,"standard":"500ml”,"shelfLife":"180”,"4""l"category:5,“barcode":"6930000000001*,z,certNo":"12345678”,zirCertPicture*:,data:application/jpeg;base64,dk8234klj0ksjdfkl23iosdf=w,“production”:wProductionDatezz:*2022-01-01,“batchNumbe:“20220101",“origin":"上海市",*certificationPicture*:*data:application/jpegjbase64,dk8234kljOksjdfkl23iosdf=*,"CertNoOfOriginw:"CDZ00000,*certNoOfOriginPicturez':"data:application/jpeg;base64,dk8234klj0ksjdfkl23iosdf=z,“ciQNo"Jciqooooooi",“CIQPicture":"data:application/jpeg;base64,dk8234kljksjdfkl23iosdf=","quarantineinstitution":"检疫机构A”,*certNoOfQuarantine”:z,JYZSOOOOO1”,zzCertNoOfQuarantinePicture":"data:application/jpeg;base64,dk8234k1jksjdfk123iosdf=",*executiVeStandarcr:GB/TXXXXXX”),“circulation”:(“quantity”:1000,unit:吨,“saleDate":"2022-02-01”,“customerName":"江苏省南京市XXXX有限公司”,*customerAddr*:"江苏省南京市XXX路XXX号”,“customerTel":"138000000000”,"uniSCID*:,91310000000000000X","iicNo":"Jyoooooooooooooo"),“inspection”:("enterpriseName":"被抽样单位名称A”,"uniSCID":,91310000000000000X"address”:抽样地点”,province:上海巾,"city”:上海市,“county":"黄浦区",“sampleName":"样品名称A,“category”:食品大类,“subcategories":"食品亚类","sampleStandard":"样品规格,“batchNumber”:样品批号,“productionDate”:*2022-01-01*,“checkTime”:2022-02-01,“reportDate”:2022-02-05,"producerName":"标识生产企业名称,"producerAddress":"标识生产企业地址,sampleNumber:“SNOOOOOOOOOX”,"checkIte:"检测项目A”,表A5返回消息代码示例表(续)zrStandardValue*:"3.05.0”,“inspectValue":"实际检测值4.1",*InspectionResults*:"1”,inspectiOnAgency":"上海检测机构A”)A.6接口响应码说明接口响应码见表A.6。表A.6接口响应码及状态说明响应码状态说明200服务器已成功处理请求401未获得登录授权或令牌失效403服务器拒绝请求404服务器找不到请求的接【I或页面500服务器遇到错误,无法完成请求502服务器作为网关或代理,从上游服务器收到无效响应503服务器目前无法使用(由于超载或停机维护)504服务器作为网关或代理,但是没有及时从上游服务器收到请求