《农产品质量安全追溯 数据接口规范》.docxVIP

1

农产品质量安全追溯数据接口规范

1范围

本文件规定了农产品质量安全追溯数据接口的缩略语、技术要求、接口实现、接口数据和接口安全。

本文件适用于农产品质量安全追溯的监督管理、平台建设、互联互通、信息采集、信息归集、推广应用、基础研究及技术服务。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。

GB/T7408数据元和交换格式信息交换日期和时间表示法

NY/TXXXX农产品质量安全追溯术语

NY/TXXXX农产品质量安全追溯数据格式规范

RFC3548-TheBase16,Base32,andBase64DataEncodings

RFC3629-UTF-8,atransformationformatofISO10646

3术语和定义

NY/TXXXX《农产品质量安全追溯术语》界定的以及下列术语和定义适用于本文件。

3.1

服务描述语言webservicesdescriptionlanguage；WSDL

基于可扩展标记语言（XML）的一种应用，用于描述WebService及其函数、参数和返回值。

注：WSDL将Web服务描述定义为一组服务访问点，客户端可以通过这些服务访问点对包含面向文档信息或面向过程调用的服务进行访问。

3.2

Webservices服务接口

是一个追溯平台独立的、低耦合的web应用服务程序，适用于不同信息系统间的互联互通。

4缩略语

下列缩略语适用于本文件。

CRUD：指在做计算处理时的增加（Create）、检索（Retrieve）、更新（Update）和删除（Delete）几个单词的首字母简写，用于描述软件系统中数据库或者持久层的基本操作功能。

HTTP：超文本传输协议（HyperTextTransferProtocol）

JSON：一种轻量级的数据交换格式（JavaScriptObjectNotation）

SOAP：简易对象访问协议（SimpleObjectAccessProtocol）

UTF-8：一种可变长度字符编码（8-bitUnicodeTransformationFormat）

token：是服务端生成的一串加密字符串、以作客户端进行请求的一个“令牌”XML：可扩展标记语言（ExtensibleMarkupLanguage）

2

5技术要求

5.1设计原则

接口设计应遵循高内聚、低耦合的设计原则，具体如下：

——遵循SOAP组件化设计思想及web2.0的CRUD设计原则，实现系统间的松散耦合；——以XML格式数据为主要数据载体；

——充分考虑接口所涉及的各个系统的应用扩展情况；

——保证接口数据在各系统间的一致性；

——在数据交互过程中，应具有传送和接收后的确认过程；

——具有较高的通用性和可靠性，使用简单、快捷。

5.2基本要求

5.2.1接口要求

接口通过服务调用实现信息交换，应符合下列要求：

——采用GB/T7408规定的日期类型；

——采用RFC3548规定的Base64编码规则将图片文件转换为字符串；

——建立接口日志记录，能识别数据异常或追溯交换数据情况。

5.2.2容错要求

发生错误时，接口服务方将详细的错误信息返回至接口调用方，由接口调用方对错误进行记录分析和整改。

5.3接口协议

接口协议方式包括：

——采用基于HTTP的简单对象访问协议SOAP；

——采用基于XML的描述语言WSDL；

——采用RFC3629规定的UTF-8字符集；

——接口请求与接口响应均采用JSON数据交换格式。

6接口实现

6.1调用地址

以接口服务方追溯平台发布的接口地址为准。

6.2调用步骤

6.2.1数据推送

定制数据推送资源的数据结构和格式，申请使用数据推送的资源，获得访问数据推送服务的访问令牌和访问地址。

数据新增、变更、删除时，接口调用方使用访问令牌调用接口服务方追溯平台推送的webservice服务，将数据推送到接口服务方追溯平台。

6.2.2数据获取

定制数据获取资源的数据项，申请使用数据获取的资源，获得数据获取服务的访问令牌和访问地址。

数据查询和同步日志获取时，使用访问令牌调用接口服务方追溯平台推送的webservice服务，接收来自接口服务方追溯平台的数据。

3