食品流通信息化质量管理体系建设规范.docx

1

食品配送企业食品追溯系统数据接口规范

1范围

本标准规定了食品配送企业食品追溯系统数据接口的术语和定义、数据接口及认证方式、数据接口说明以及接口验收标准。

本标准适用于食品配送企业食品追溯系统的接入与应用，也可用于指导食品配送企业食品追溯系统的开发。

2规范性引用文件

下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。

GB/T1.1-2009标准的结构和编写

GB/T2659-2000世界各国和地区名称代码

GB/T7635.1-2002T全国主要产品分类与代码

3术语和定义

下列术语和定义适用于本文件。

3.1

数据接口Datainterface

计算机软件系统之间传送数据、交换信息的接口，以电子文件的形式实现。

3.2

食品配送企业食品追溯系统

DataInterfaceSpecificationForFoodTraceabilitySystemOfFoodDistributionEnterprises

“食品配送企业食品追溯系统”是一个能够连接食品生产、检验、监管、配送和消费各个环节，让消费者了解符合卫生安全的生产和流通过程，提高消费者放心程度的信息管理系统。

4缩略语

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

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

JSON：JavaScript对象标记语言（JavaScriptObjectNotation）

2

T/GDFCA019—2019

5数据接口及认证方式

5.1数据接口范围及内容

食品配送企业食品追溯系统应提供一系列的接口，应包括且不限于如图所示功能：

图1食品配送企业食品追溯系统接口范围

5.2认证方式

本系统中，接口使用方在调用数据接口前必须经过认证，接口提供方需提供认证接口给接口使用方进行认证操作。接口提供方为每个接口使用方分配应用标识和凭据（authID和authKey），接口使用方调用认证接口，通过应用标识和凭据获取具有一定时效性的有效令牌，之后调用数据接口均需带上该令牌。

6数据接口说明

6.1数据格式

本系统需采用JSON作为系统间的数据传输格式，调用接口时请求数据和返回数据均采用JSON格式。系统中传输的数据格式如表1所示，在定义参数类型时只能从这六种类型中选取。

表1数据传输格式

类型

格式

示例

字符

字符串

userName:“张三”

数字

整型、浮点型

age:24

日期

YYYY-MM-DD

birthday:“1983-12-05”

时间

YYYY-MM-DDHH:mm:ss

createTime:“1983-12-0513:05:00”

数组

列表

data：[{11,12},{21,22}]

布尔型

布尔型

isDeleted:“false”

6.2企业信息查询接口

6.2.1概述

主要功能是获取企业信息。

6.2.2企业信息查询接口函数

a)接口说明：获取企业信息

b)接口地址：http://serverurl/eniotis/enterpriseInfo.do?action=listc)请求方式：post。

a)请求参数列表：见表2。

表2查询企业信息列表接口请求参数列表

参数

是否必填

说明

数据类型

3

enterpriseName

否

企业名称

字符串

linkMan

否

联系人

字符串

linkPhone

否

联系电话

字符串

enterpriseType

否

企业类型

字符串

b)返回参数说明：见表3。

b)

表3查询企业信息列表接口返回参数列表

参数

说明

数据类型

Code

状态码：成功返回0，失败返回非0

数字

Message

状态说明

数字

data

Page

页码

数字

Total

返回记录数

数字

Records

总记录数

数字

rows

id

主键id

数字

enterpriseType

企业类型

字符串

enterpriseName

企业名称

字符串

manager

联系人

字符串

managerPhone

联系电话

字符串

remark

备注

字符串

c)返回参数示列：

{

code:0,

message:success,

data:{

page:1,

total:10,

records:35,

rows:{

id:245461234564546,

enterpriseType:企业类型,

enterpriseName:企业名称,

manager:联系人