背景

本文旨在为自动化立体仓库数据同步条件的平台开放服务，提供统一的HTTP接口调用与交互规范。

本文中描述的规范包括AS/RS功能模块的数据同步接口。

规范适用对象说明

本规范仅适用于由平台之间服务器端发起调用请求，包括POST提交数据以及GET请求数据。

名词解释

• AS/RS：自动化立体仓库仓储系统
• WMS：仓库管理系统。
• WCS：仓储设备管理控制系统。
• PDA：安装了立库移动端软件应用、可进行扫码的手持终端设备。
• 全部同步：不管数据有无变化，同步周期内全部数据同步上传。
• 增量同步：同步周期内有变化（新增、修改、更新）的数据同步上传。

URL及数据包格式规范

URL

• 服务器提供如下风格的HTTP接口。
• http://{host}:{port}/{prefix}/open/asrs/{url}
• 注1：所有Http请求以POST方式，JSON提交进行
• 注2：响应报文同为JSON字符串

参数

系统级参数

• 以下参数是由开发平台端定义，系统需支持这些参数以便识别调用接口的客户端。

参数名	类型	是否必须	描述
appkey	string	是	平台认证唯一密钥

业务级参数

遵守数据交换规范中业务级通用参数的约定。

表格4-2业务级参数的通用约定

ERP遵守数据交换规范中业务级通用参数的约定。

响应数据包格式规范

目前接口的返回格式全部采用JSON格式。

JSON输出格式

响应包符合如下规范的标准JSON字符串：

• http响应头中的Content-Type指定:application/json;charset=utf-8
• 字符串编码格式是utf-8

接口响应输出格式

响应输出格式

{ "code":200, "msg":"操作成功", "data":null }

获取成功信息

code	msg	data
200	操作成功	接口返回业务数据

错误响应输出格式

错误响应输出内容符合以下规范：

返回内容由code,msg,data此三类属性组成，分别用于描述错误编码，以及错误信息。

{ "code":500, "msg":"服务器内部错误", "data":null }

错误码定义如下表所示：

code	描述
201	暂无数据
401	参数为空
403	权限不足
407	请勿重复提交
500	服务器错误