<!doctype html>
|
<html lang="en">
|
<head>
|
<meta charset="UTF-8">
|
<meta name="viewport"
|
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
<meta http-equiv="X-UA-Compatible" content="ie=edge">
|
<link rel="icon" type="image/x-icon" href="../static/image/favicon.ico" />
|
<link rel="stylesheet" href="../static/css/api_index/api_index.css">
|
<title>api | AS / RS</title>
|
</head>
|
<body>
|
<div class="header">
|
|
</div>
|
<div class="siderbar">
|
<div >
|
<ul>
|
<li>背景</li>
|
</ul>
|
</div>
|
</div>
|
<div class="main">
|
<div class="main-box">
|
<h1>背景</h1>
|
<p>本文旨在为自动化立体仓库数据同步条件的平台开放服务，提供统一的HTTP接口调用与交互规范。</p>
|
<p>本文中描述的规范包括AS/RS功能模块的数据同步接口。</p>
|
<h1>规范适用对象说明</h1>
|
<p>本规范仅适用于由平台之间服务器端发起调用请求，包括POST提交数据以及GET请求数据。</p>
|
<h2>名词解释</h2>
|
<ul>
|
<li><span>AS/RS：自动化立体仓库仓储系统</span></li>
|
<li><span>WMS：仓库管理系统。</span></li>
|
<li><span>WCS：仓储设备管理控制系统。</span></li>
|
<li><span>PDA：安装了立库移动端软件应用、可进行扫码的手持终端设备。</span></li>
|
<li><span>全部同步：不管数据有无变化，同步周期内全部数据同步上传。</span></li>
|
<li><span>增量同步：同步周期内有变化（新增、修改、更新）的数据同步上传。</span></li>
|
</ul>
|
<h1>URL及数据包格式规范</h1>
|
<h2>URL</h2>
|
<ul>
|
<li><span>服务器提供如下风格的HTTP接口。</span></li>
|
<li><span>http://{host}:{port}/{prefix}/open/asrs/{url}</span></li>
|
<li><span>注1：所有Http请求以POST方式，JSON提交进行</span></li>
|
<li><span>注2：响应报文同为JSON字符串</span></li>
|
</ul>
|
<h2>参数</h2>
|
<h3>系统级参数</h3>
|
<ul>
|
<li><span>以下参数是由开发平台端定义，系统需支持这些参数以便识别调用接口的客户端。</span></li>
|
</ul>
|
<table border="1">
|
<tr><th>参数名</th><th>类型</th><th>是否必须</th><th>描述</th></tr>
|
<tr><td>appkey</td><td>string</td><td>是</td><td>平台认证唯一密钥</td></tr>
|
</table>
|
<h3>业务级参数</h3>
|
<p>遵守数据交换规范中业务级通用参数的约定。</p>
|
<p>表格4-2业务级参数的通用约定</p>
|
<p>ERP遵守数据交换规范中业务级通用参数的约定。</p>
|
<h2>响应数据包格式规范</h2>
|
<p>目前接口的返回格式全部采用JSON格式。</p>
|
<h3>JSON输出格式</h3>
|
<p>响应包符合如下规范的标准JSON字符串：</p>
|
<ul>
|
<li>http响应头中的Content-Type指定:application/json;charset=utf-8</li>
|
<li>字符串编码格式是utf-8</li>
|
</ul>
|
<h3>接口响应输出格式</h3>
|
<ur><li>响应输出格式</li></ur>
|
<code>
|
{
|
"code":200,
|
"msg":"操作成功",
|
"data":null
|
}
|
</code>
|
<ur><li>获取成功信息</li></ur>
|
<table border="1">
|
<tr><td>code</td><td>msg</td><td>data</td></tr>
|
<tr><td>200</td><td>操作成功</td><td>接口返回业务数据</td></tr>
|
</table>
|
<h3>错误响应输出格式</h3>
|
<p>错误响应输出内容符合以下规范：</p>
|
<ur><li>返回内容由code,msg,data此三类属性组成，分别用于描述错误编码，以及错误信息。</li></ur>
|
<p>{
|
"code":500,
|
"msg":"服务器内部错误",
|
"data":null
|
}
|
</p>
|
<p>错误码定义如下表所示：</p>
|
<table border="1">
|
<tr><th>code</th><th>描述</th></tr>
|
<tr><td>201</td><td>暂无数据</td></tr>
|
<tr><td>401</td><td>参数为空</td></tr>
|
<tr><td>403</td><td>权限不足</td></tr>
|
<tr><td>407</td><td>请勿重复提交</td></tr>
|
<tr><td>500</td><td>服务器错误</td></tr>
|
</table>
|
</div>
|
</div>
|
</body>
|
</html>
|
