DB32T 3411-2018 食品安全电子追溯信息查询服务数据接口规范.pdf

ICS 67.040 X 00 备案号：60247-2018 DB32 江苏省地方标准 DB 32/T 34112018 食品安全电子追溯信息查询服务 数据接口规范 Interface specifications of information query service for food safety electronic traceability 2018-06-25 发布 2018-07-10 实施 江苏省质量技术监督局 发 布 DB32/T 34112018 I 目 次 前 言.III 1 范围.1 2 规范性引用文件.1 3 术语和定义.1 4 缩略语.2 5 信息查询服务功能要求.2 5.1 系统架构.2 5.2 信息查询服务基本功能.3 6 信息查询服务接口要求.3 6.1 基本要求.3 6.1.1 IQS 传输接口.3 6.1.2 IQS 查询接口.4 6.2 接口原语.4 6.3 基本数据类型.4 6.4 接口调用方式.4 6.4.1 请求.4 6.4.2 响应.5 7 主数据传输接口.5 7.1 接口基本功能.5 7.2 接口定义.5 7.3 接口调用.6 8 事件传输接口.6 8.1 接口基本功能.6 8.2 接口定义.6 8.3 接口调用.7 9 资源文件传输接口.7 9.1 接口基本功能.7 9.2 接口定义.7 9.3 接口调用.7 10 查询接口.8 10.1 接口基本功能.8 10.2 接口定义.8 10.3 接口调用.9 DB32/T 34112018 II 附录 A（规范性附录）EPCISEvent 定义.10 附录 B（规范性附录）SimpleEventQuery 时 params 参数.20 附录 C（规范性附录）SimpleMasterDataQuery 时 params 参数.27 附录 D（规范性附录）AuthenticatedEQuery 时 params 参数.29 附录 E（规范性附录）AuthenticatedMDQuery 时 params 参数.36 附录 F（资料性附录）主数据传输应用示例.38 附录 G（资料性附录）事件传输应用示例.39 附录 H（资料性附录）资源文件上传应用示例.40 附录 I（资料性附录）查询接口应用示例.41 DB32/T 34112018 III 前 言 本标准按照GB/T 1.12009给出的规则起草。本标准由江苏省食品药品监督管理局提出并归口。本标准起草单位：江苏省质量和标准化研究院、复旦大学无锡研究院、中科院计算机网络中心、无锡捷玛科技物联有限公司。本标准主要起草人：胡冶、崔兆明、王俊宇、刘毅、曹云、杨博、刘佳、周广军、王瑜、钱侃、王开疆、吴双力、田野。DB32/T 34112018 1 食品安全电子追溯信息查询服务数据接口规范 1 范围 本标准规定了食品安全电子追溯信息查询服务的功能要求、数据接口。本标准适用于食品安全电子追溯信查查询服务的接口实现。2 规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T 17295 国际贸易计量单位代码 DB32/T 3407-2018 食品安全电子追溯标识解析服务数据接口规范 RFC 2616 超文本传输协议1.1(Hypertext transfer protocol-HTTP/1.1)RFC 4627 JSON格式定义(The application/JSON media type for javascript object notation)RFC 4825 可扩展标记语言配置接入协议(The extensible markup language(XML)configuration access protocol(XCAP)3 术语和定义 下列术语和定义适用于本文件。3.1 信息查询服务 information query service 提供追溯信息传输、查询和数据上报功能的服务。3.2 网元 network element 由软硬件共同组成的能实现网络中的一种或多种逻辑功能的逻辑单元。3.3 IQS网元 information query service network element 提供信息查询服务的网元。3.4 IRS网元 identification resolution service network element 提供追溯标识注册和追溯标识解析服务的网元。DB32/T 34112018 2 3.5 DCS网元 data catalog service network element 提供追溯路径的建立和查询服务的网元。3.6 EU网元 end user network element 终端用户所使用的具备追溯查询能力的软件系统的统称。3.7 CU网元 capture unit network element 负责采集数据、上传的网元。3.8 SP网元 supervisor platform network element 负责接收IQS网元上报的追溯数据，并利用追溯数据进行监管行为的网元。3.9 追溯代理 traceability proxy 以用户发起的HTTP追溯查询请求为触发，代替追溯用户调用IRS,DCS和IQS网元的多个接口完成追溯查询逻辑功能的网元。4 缩略语 下列缩略语适用于本文件。CU：捕获单元(Capture Unit)DNS：域名服务(Domain Name Service)DCS：数据目录服务(Data Catalog Service)EU：终端用户(End User)IQS：信息查询服务(Information Query Service)IRS：标识解析服务(Identification Resolution Service)JSON：JS对象标记(Java Script Object Notation)RFID：射频识别(Radio Frequency Identification)SP：监管平台(Supervisor Platform)URL：统一资源定位符(Uniform Resource Locator)URN：统一资源名称（Uniform Resource Name）XML：可扩展标记语言(Extensible Markup Language)5 信息查询服务功能要求 5.1 系统架构 DB32/T 34112018 3 食品安全电子追溯系统应由企业平台、监管平台和查询平台组成，食品安全电子追溯系统的系统架构见DB32/T XXXX。信息查询服务由IQS网元实现，IQS网元架构图见图1。图1 IQS 网元构架 5.2 信息查询服务基本功能 信息查询服务应提供但不限于以下功能：a)传输服务通过数据传输接口接收企业平台（CU 网元）传输的追溯数据；b)查询服务通过查询接口与查询平台交互实现追溯数据的查询。6 信息查询服务接口要求 6.1 基本要求 食品安全电子追溯系统的各个网元之间应通过Internet公共以太网接口互联互通。IQS网元与其他网元的物理接口上承载的协议栈应为HTTP或HTTPS协议栈，数据接口应使用基于HTTP/HTTPS协议的JSON格式的消息体传输数据。IQS接口分为：a)数据传输接口；b)查询接口。6.1.1 IQS 传输接口 食品生产经营企业信息管理系统通过该接口和IQS网元交互，使用传输服务。IQS传输接口分为：a)主数据传输接口；b)事件传输接口；c)资源文件传输接口。DB32/T 34112018 4 6.1.2 IQS 查询接口 查询平台通过该接口和IQS网元交互，使用查询服务。6.2 接口原语 基于服务的方式定义数据接口的使用方法。服务响应流程使用了“请求-Request”“指示-Indication”“响应-Response”“确认-Confirm”四条服务原语，原语的顺序见图2。客户端服务器HTTPRequest消息请求-Request指示-IndicationHTTPResponse消息响应-Response确认-Confirm 图2 服务响应流程 6.3 基本数据类型 IQS网元接口基本数据类型见表1。表1 基本数据类型 类型名 类型描述 类型约束 String 文本字符串 内容为所有的有效字符 List 列表类型 每一项均为一个子数据项，子数据项编码方式与父数据项编码方式相同。Time 时间类型 UTC 时间表示法：YYYY-MM-DDTHH:mm:ss.SSSZ 本地时间表示法：YYYY-MM-DDTHH:mm:ss.SSSzoneoffset float 浮点数类型 内容为浮点数类型字符 int 整数类型 内容为整形字符 file 文件流类型 内容为对文件的操作定义 Boolean 数值类型 内容为 True 或 False 6.4 接口调用方式 6.4.1 请求 DB32/T 34112018 5 请求接口应符合RFC 2616中对HTTP请求的规定，使用Get或者POST方法调用接口，并将请求参数按照消息格式用JSON封装后，包含在HTTP的Request消息的Body中发送给对方。6.4.2 响应 接口调用成功后，应由IQS网元进行处理，处理方式应符合RFC 4825对XML的规定或RFC 4627对JSON格式的规定，处理结束后应将处理结果放置在HTTP的Response消息的Body中，返回给调用者。HTTP的Response消息应符合RFC 2616中的规定。7 主数据传输接口 7.1 接口基本功能 提供食品生产经营企业提供向IQS提交静态数据的功能。注：静态数据包括食品生产企业的企业基本信息、原料基本信息、供货厂商基本信息、生产流程基本信息、产成品基本信息、销售商基本信息、原料及产生品检验信息等。7.2 接口定义 接口名称：vocabularyCapture。主数据传输接口请求参数及响应参数见表2、表7。表2 主数据传输接口请求参数 参数名称 类型 最大长度 Byte 是否必填 描述 EPCISMasterDataBody EPCISMasterDataDocumentType 255 是 主数据结构，EPCISMasterDataDocumentType定义见表3 表3 EPCISMasterDataDocumentType 数据结构 参数名称 类型 最大长度 Byte 是否必填 描述 VocabularyList List 单个标识最大长度为 255 是 主数据列表，VocabularyListType 定义见表 4 表4 VocabularyListType 数据参数 参数名称 类型 最大长度 Byte 是否必填 描述 type String 255 是 主数据类型 参数名称 类型 最大长度 Byte 是否必填 描述 VocabularyElementList List 单个标识最大长度为 255 是 主数据内容列表，VocabularyElementListType 定义见表 5 DB32/T 34112018 6 表5 VocabularyElementListType 数据参数 参数名称 类型 最大长度 Byte 是否必填 描述 id String 255 是 主数据主键 attribute List 单个标识最大长度为 255 是 主数据属性，attributeType 定义见表 6 表6 attributeType 数据参数 参数名称 类型 最大长度 Byte 是否必填 描述 id String 255 是 属性名称/编码 value String 255 是 属性内容 表7 主数据传输接口返回参数 参数名称 类型 最大长度 Byte 是否必填 描述 Status String 255 是 返回数据传输结果 success：传输成功，false：传输失败 7.3 接口调用 静态数据不随生产活动而变化，静态数据因企业其他活