<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>i5ting_ztree_toc:api</title>
<link href="toc/style/GitHub.css" media="all" rel="stylesheet" type="text/css"/>
<link href="toc/style/GitHub2.css" media="all" rel="stylesheet" type="text/css"/>
<link href="toc/css/zTreeStyle/zTreeStyle.css" media="all" rel="stylesheet" type="text/css"/>
<style>
pre {
counter-reset: line-numbering;
border: solid 1px #d9d9d9;
border-radius: 0;
background: #fff;
padding: 0;
line-height: 23px;
margin-bottom: 30px;
white-space: pre;
overflow-x: auto;
word-break: inherit;
word-wrap: inherit;
}
pre a::before {
content: counter(line-numbering);
counter-increment: line-numbering;
padding-right: 1em; /* space after numbers */
width: 25px;
text-align: right;
opacity: 0.7;
display: inline-block;
color: #aaa;
background: #eee;
margin-right: 16px;
padding: 2px 10px;
font-size: 13px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
pre a:first-of-type::before {
padding-top: 10px;
}
pre a:last-of-type::before {
padding-bottom: 10px;
}
pre a:only-of-type::before {
padding: 10px;
}
.highlight { background-color: #ffffcc } /* RIGHT */
</style>
</head>
<body>
<div>
<div style='width:25%;'>
<ul id="tree" class="ztree" style='width:100%'>
</ul>
</div>
<div id='readme' style='width:90%;margin-left:20%;'>
<article class='markdown-body'>
<h1 id="-">设备管理服务平台</h1>
<table>
<thead>
<tr>
<th>版本</th>
<th>创建时间</th>
<th>作者</th>
<th>备注信息</th>
</tr>
</thead>
<tbody>
<tr>
<td>v1.0</td>
<td>2022-01-20</td>
<td>zxfei</td>
<td>接口文档</td>
</tr>
</tbody>
</table>
<h2 id="-">数据类型</h2>
<table>
<thead>
<tr>
<th>类型名称</th>
<th>类型描述</th>
<th>参考样例</th>
</tr>
</thead>
<tbody>
<tr>
<td>String</td>
<td>字符串</td>
<td>A、a、ab</td>
</tr>
<tr>
<td>Integer</td>
<td>数字类型</td>
<td>1、12、-1</td>
</tr>
<tr>
<td>Long</td>
<td>长整型数字</td>
<td>1、12、-1</td>
</tr>
<tr>
<td>date</td>
<td>时间类型,单位纳秒数字</td>
<td>167988745573</td>
</tr>
<tr>
<td>BigDecimal</td>
<td>小数类型</td>
<td>545.256</td>
</tr>
<tr>
<td>object</td>
<td>对象类型</td>
<td>{"name":"zhang3"}</td>
</tr>
<tr>
<td>arrays</td>
<td>数组类型</td>
<td>[{"name":"zhang3"},{"name":"zhang2"}]</td>
</tr>
</tbody>
</table>
<h2 id="-">接口服务</h2>
<h3 id="-">设备激活</h3>
<p><strong>请求URL:</strong> api/active</p>
<p><strong>请求方式:</strong> POST</p>
<p><strong>内容类型:</strong> application/json;charset=utf-8</p>
<p><strong>简要描述:</strong> 设备激活</p>
<p><strong>请求参数:</strong></p>
<table>
<thead>
<tr>
<th>参数名称</th>
<th>类型</th>
<th>备注</th>
<th>必填</th>
<th>其它</th>
</tr>
</thead>
<tbody>
<tr>
<td>deviceNum</td>
<td>String</td>
<td>设备编码</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>deviceMac</td>
<td>String</td>
<td>设备MAC</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>type</td>
<td>Integer</td>
<td>设备类型（1.呼叫器，2.窗口屏, 3.评价器，4.集中屏, 5.排号机，6.im设备, 7.样表设备，8.取件柜, 9.信息发布,10.导视机,11.开标室设备,12.背靠背）</td>
<td>是</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求样例:</strong></p>
<pre class="prettyprint linenums:0"><code>
{
"userName":"zhang3",
"password":"123456",
"securityCode":"5455"
}
</code></pre><p><strong>响应参数:</strong></p>
<table>
<thead>
<tr>
<th>参数名称</th>
<th>参数类型</th>
<th>备注</th>
<th>其它</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>Integer</td>
<td>结果码（-1.失败，1.成功）</td>
<td>-</td>
</tr>
<tr>
<td>msg</td>
<td>String</td>
<td>消息</td>
<td>-</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>数据对象</td>
<td>-</td>
</tr>
<tr>
<td> token</td>
<td>Integer</td>
<td>激活后返回token</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>响应消息样例:</strong></p>
<pre class="prettyprint linenums:0"><code>
{
"msg":"登录成功",
"code":1,
"data":{
}
}
</code></pre><h3 id="-">设备上报</h3>
<p><strong>请求URL:</strong> api/upload</p>
<p><strong>请求方式:</strong> POST</p>
<p><strong>请求头校验:</strong> Authorization: Bearer {{authToken}}</p>
<p><strong>内容类型:</strong> application/json;charset=utf-8</p>
<p><strong>简要描述:</strong> 设备上报日志</p>
<p><strong>请求参数:</strong></p>
<table>
<thead>
<tr>
<th>参数名称</th>
<th>类型</th>
<th>备注</th>
<th>必填</th>
<th>其它</th>
</tr>
</thead>
<tbody>
<tr>
<td>deviceNum</td>
<td>String</td>
<td>设备编码</td>
<td>是</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求样例:</strong></p>
<pre class="prettyprint linenums:0"><code>
{
"userName":"zhang3",
"password":"123456",
"securityCode":"5455"
}
</code></pre><p><strong>响应参数:</strong></p>
<table>
<thead>
<tr>
<th>参数名称</th>
<th>参数类型</th>
<th>备注</th>
<th>其它</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>Integer</td>
<td>结果码（-1.失败，1.成功）</td>
<td>-</td>
</tr>
<tr>
<td>msg</td>
<td>String</td>
<td>消息</td>
<td>-</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>数据对象</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>响应消息样例:</strong></p>
<pre class="prettyprint linenums:0"><code>
{
"msg":"登录成功",
"code":1,
"data":{
}
}
</code></pre><h2 id="-">消息</h2>
<h3 id="-">上行消息</h3>
<p><strong>topic:</strong> /upload/{deviceMac}</p>
<p><strong>请求方式:</strong> rabbmitMQ</p>
<p><strong>内容类型:</strong> application/json;charset=utf-8</p>
<p><strong>简要描述:</strong> 上行消息存放队列</p>
<p><strong>请求参数:</strong></p>
<table>
<thead>
<tr>
<th>参数名称</th>
<th>类型</th>
<th>备注</th>
<th>必填</th>
<th>其它</th>
</tr>
</thead>
<tbody>
<tr>
<td>headers</td>
<td>Object</td>
<td>消息头</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td> data</td>
<td>Object</td>
<td>消息头数据对象</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>  protocol</td>
<td>String</td>
<td>数据域协议类型，默认json</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>  messageType</td>
<td>String</td>
<td>上报消息类型</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>  sign</td>
<td>String</td>
<td>签名</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>  timestamp</td>
<td>String</td>
<td>时间戳</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>data</td>
<td>byte[]</td>
<td>byte数组，base64编码</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>key</td>
<td>String</td>
<td>消息唯一标识</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求样例:</strong></p>
<pre class="prettyprint linenums:0"><code>{
"data":"YWJjZDEyMzQ=",
"headers":{
"data":{
"protocol":"json",
"messageType":"UPGREAD",
"sign":"abcd1234",
"timestamp":"2022-04-15 09:48:05"
}
},
"key":"d3635cd0-597d-46c8-8b85-797c3846b04f"
}
</code></pre><h3 id="-">下行消息</h3>
<p><strong>topic:</strong> /down/{deviceMac}</p>
<p><strong>请求方式:</strong> rabbmitMQ</p>
<p><strong>内容类型:</strong> application/json;charset=utf-8</p>
<p><strong>简要描述:</strong> 下行消息存放队列</p>
<p><strong>请求参数:</strong></p>
<table>
<thead>
<tr>
<th>参数名称</th>
<th>类型</th>
<th>备注</th>
<th>必填</th>
<th>其它</th>
</tr>
</thead>
<tbody>
<tr>
<td>headers</td>
<td>Object</td>
<td>消息头</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td> data</td>
<td>Object</td>
<td>消息头数据对象</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>  protocol</td>
<td>String</td>
<td>数据域协议类型，默认json</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>  messageType</td>
<td>String</td>
<td>上报消息类型</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>  sign</td>
<td>String</td>
<td>签名</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>  timestamp</td>
<td>String</td>
<td>时间戳</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>data</td>
<td>byte[]</td>
<td>byte数组，base64编码</td>
<td>是</td>
<td>-</td>
</tr>
<tr>
<td>key</td>
<td>String</td>
<td>消息唯一标识</td>
<td>-</td>
</tr>
</tbody>
</table>
<p><strong>请求样例:</strong></p>
<pre class="prettyprint linenums:0"><code>{
"data":"YWJjZDEyMzQ=",
"headers":{
"data":{
"protocol":"json",
"messageType":"UPGREAD",
"sign":"abcd1234",
"timestamp":"2022-04-15 09:48:05"
}
},
"key":"d3635cd0-597d-46c8-8b85-797c3846b04f"
}
</code></pre>
</article>
</div>
</div>
</body>
</html>
<script type="text/javascript" src="toc/js/jquery-1.4.4.min.js"></script>
<script type="text/javascript" src="toc/js/jquery.ztree.all-3.5.min.js"></script>
<script type="text/javascript" src="toc/js/ztree_toc.js"></script>
<script type="text/javascript" src="toc_conf.js"></script>
<script type="text/javascript" src="toc/js/run_prettify.js"></script>
<SCRIPT type="text/javascript" >
<!--
$(document).ready(function(){
var css_conf = eval(markdown_panel_style);
$('#readme').css(css_conf)
var conf = eval(jquery_ztree_toc_opts);
$('#tree').ztree_toc(conf);
});
//-->
</SCRIPT>