肉品溯源数据接口规范.docxVIP

1

肉品溯源数据接口规范

1范围

本文件规定了调用肉品（批发）溯源系统的数据接口进行数据交换的接口方法和调用说明。本文件适用于调用肉品（批发）溯源系统的数据接口的集成开发。

2规范性引用文件

本文件没有规范性引用文件。

3术语和定义

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

3.1

数据接口datainterface

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

[来源：GB/T42940—2023,3.3]

3.2

数据对接方datadockingparty

数据接口调用者，与肉品（批发）溯源系统进行数据交换的单位。

4缩略语

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

API：应用程序编程接口（ApplicationProgrammingInterface）HTTP：超文本传输协议（HyperTextTransferProtocol）

JSON：对象简谱（JavascriptObjectNotation）

5接口方法及调用说明

5.1接口传输要求及对接流程

5.1.1接口使用JSON传输数据，技术接口对接示意如图1所示。肉品数据对接方系统获取访问令牌，

访问验证通过后，根据预先定义好的接口方法，进行肉品溯源数据交换，数据接口应用示例见附录A。注：肉品溯源数据主要包含分销台账数据、动物检疫合格证明（以下简称“动检证”）数据等。

5.1.2数据交换分为三种方式：

a)数据对接方系统输入参数，同步肉品溯源数据后，肉品（批发）溯源系统（以下简称“溯源系统”）自动实时返回溯源数据同步结果；

b)数据对接方系统主动进行动检证核验结果查询；

2

c)数据对接方系统输入参数，同步肉品溯源数据后，溯源系统自动实时返回溯源数据同步结果和动检证核验结果。

注：Token指邀请、登录系统的临时令牌。

图1技术接口对接示意图

5.2数据类型

数据接口应支持的数据类型包括:

a)字符型；

b)整数型；

c)浮点型；

d)布尔型；e)日期型；

f)对象型。

3

5.3数据接口

5.3.1凭据Token调用接口

接口说明

接口说明如下：

a)接口名称：接口访问授权调用接口；

b)接口描述：用于获取业务接口的访问调用凭据；

c)HTTP请求方式：GET；

d)接口标识符：GetToken。

接口输入参数及说明

凭据Token调用接口的输入参数及说明见表1。

表1凭据Token调用接口的输入参数及说明

输入参数

数据类型

是否非空

说明

Params

appId

字符型

是

应用码

appSecret

字符型

是

应用授权码

接口返回参数及说明

凭据Token调用接口的返回参数及说明见表2。

表2凭据Token调用接口的返回参数及说明

返回参数

数据类型

是否非空

说明

data

success

布尔型

是

调用结果，若为“true”，表示成功；若为“false”，表示失败

message

字符型

是

提示信息

code

整数型

是

成功则返回代码“0”；失败则返回错误码“500”

result

字符型

是

授权访问令牌Token

timestamp

整数型

是

时间戳

5.3.2同步肉品溯源数据的调用接口

接口说明

接口说明如下：

a)接口名称：同步肉品溯源数据的调用接口；

b)接口描述：用于同步数据对接方系统的肉品溯源数据；

c)HTTP请求方式：POST；

d）接口标识符：ImportData。

接口输入参数及说明

同步肉品溯源数据调用接口的输入参数及说明见表3。

4

表3同步肉品溯源数据调用接口的输入参数及说明

输入参数

数据类型

是否非空

说明

Headers

对象型

是

X-Access-Token：授权访问令牌Token

Body

salesDocumentNo

字符型

是

分销凭证编号

productBarcode

字符型

否

产品编码

productName

字符型

是

产品名称

productCategoryCode

字符型

是

产品分类编码，由“动物代码+产品代码+产品类型代码”组成，例如商品猪胴体中温肉分类编码为1010610110102，动物代码、产品代码、产品类型代码分别见附录B、附录C及附录D

productImg

字符型

否

产品图片的网址，多个网址以“，”分隔

batchCode

字符型

是

批次编码，批次唯一标识，可用“检疫合格证编号+轨道号+分割流水号”表示

batch

字符型

否

批次

batchWeight

浮点型

是