雕刻机器人商城

协议文档


数据统计数据规范

<p>[TOC]</p> <h4>发送流水数据</h4> <h5>请求URL_流水</h5> <ul> <li><code>http://xx.com/api/XXX</code></li> </ul> <h5>请求参数_流水</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">hid</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>雕刻机id</td> </tr> <tr> <td style="text-align: left;">payway</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>支付方式:微信/支付宝</td> </tr> <tr> <td style="text-align: left;">capitalAction</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>资金行为:收款/退款</td> </tr> <tr> <td style="text-align: left;">amount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>资金总额</td> </tr> <tr> <td style="text-align: left;">dataSource</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>数据来源:小程序或PC端(PC/WeChat)</td> </tr> <tr> <td style="text-align: left;">time</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>数据产生时间,由PC/WeChat决定</td> </tr> <tr> <td style="text-align: left;">tradeNo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>订单号:PC-订单号/WeChat-订单号</td> </tr> </tbody> </table> <h5>请求示例_流水</h5> <pre><code class="language-json">{ "hid":"6127-9BC9-C2F4-1575-D662", "payway":"微信", "capitalAction":"收款", "amount":"18.6", "dataSource":"PC", "time":"2022-01-04 14:31:14", "tradeNo" : "PC-??????????????????????" }</code></pre> <h5>服务器返回示例_流水</h5> <pre><code class="language-json"> { "code": "200", "msg":"成功" }</code></pre> <h4>发送喜好数据</h4> <h5>请求URL_喜好</h5> <ul> <li><code>http://xx.com/api/XXX</code></li> </ul> <h5>请求参数_喜好</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">material</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>材质名称</td> </tr> <tr> <td style="text-align: left;">pType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>图案类型</td> </tr> <tr> <td style="text-align: left;">pId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>图案Id</td> </tr> <tr> <td style="text-align: left;">hid</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>雕刻机id</td> </tr> <tr> <td style="text-align: left;">dataSource</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>数据来源:小程序或PC端(PC/WeChat)</td> </tr> <tr> <td style="text-align: left;">time</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>数据产生时间,由PC/WeChat决定</td> </tr> </tbody> </table> <h5>请求示例_喜好</h5> <pre><code class="language-json">{ "material":"金属", "pType":"1", "pId":"13", "hid":"6127-9BC9-C2F4-1575-D662", "dataSource":"PC", "time":"2022-01-04 14:31:14", }</code></pre> <h5>服务器返回示例_喜好</h5> <pre><code class="language-json"> { "code": "200", "msg":"成功" }</code></pre> <h4>发送状态与操作数据</h4> <h5>请求URL_状态与操作</h5> <ul> <li><code>http://xx.com/api/XXX</code></li> </ul> <h5>请求参数_状态与操作</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>请求码</td> </tr> <tr> <td style="text-align: left;">operation</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>操作类型,如刷新数据为refresh,累加数据为sum</td> </tr> <tr> <td style="text-align: left;">value</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>当前操作传递的参数,如心跳则传递当前时间</td> </tr> <tr> <td style="text-align: left;">hid</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>雕刻机id</td> </tr> <tr> <td style="text-align: left;">dataSource</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>数据来源:小程序或PC端(PC/WeChat)</td> </tr> <tr> <td style="text-align: left;">time</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>数据产生时间,由PC/WeChat决定</td> </tr> </tbody> </table> <h5>请求示例_状态与操作</h5> <pre><code class="language-json">{ "code":"000", "operation":"refresh", "value":"2022-01-04 14:31:14" "hid":"6127-9BC9-C2F4-1575-D662", "dataSource":"PC", "time":"2022-01-04 14:31:14", }</code></pre> <h5>服务器返回示例_状态与操作</h5> <pre><code class="language-json"> { "code": "200", "msg":"成功" }</code></pre> <h4>Code编码</h4> <p>000-099表示状态与操作功能码; 100-199为预留; 200-299请求成功的返回码 500-599表示请求失败的返回码 600-699表示错误类型</p> <table> <thead> <tr> <th style="text-align: left;">功能码</th> <th style="text-align: left;">描述</th> <th style="text-align: left;">对应操作类型</th> <th style="text-align: left;">操作类型说明</th> <th style="text-align: left;">发送源</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">000</td> <td style="text-align: left;">心跳:客户端心跳,每1min发送一次</td> <td style="text-align: left;">refresh</td> <td style="text-align: left;">对应的value为当前客户端的时间用于刷新心跳</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">001</td> <td style="text-align: left;">气压状态:每5min发送一次</td> <td style="text-align: left;">refresh</td> <td style="text-align: left;">对应的value为ready/error</td> <td style="text-align: left;">PC</td> </tr> <tr> <td style="text-align: left;">002</td> <td style="text-align: left;">设备运行状态:每5min发送一次</td> <td style="text-align: left;">refresh</td> <td style="text-align: left;">对应的value为ready/error</td> <td style="text-align: left;">PC</td> </tr> <tr> <td style="text-align: left;">003</td> <td style="text-align: left;">收款码生成次数:生成一次发送一次</td> <td style="text-align: left;">sum</td> <td style="text-align: left;">对应的value为累加的值,加1则为1</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">004</td> <td style="text-align: left;">小程序扫码次数:扫一次发送一次</td> <td style="text-align: left;">sum</td> <td style="text-align: left;">对应的value为累加的值,加1则为1</td> <td style="text-align: left;">WeChat</td> </tr> <tr> <td style="text-align: left;">005</td> <td style="text-align: left;">固定图案界面停留时间</td> <td style="text-align: left;">sum</td> <td style="text-align: left;">对应的value为累加的值,加1则为1</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">006</td> <td style="text-align: left;">DIY自动生成界面有效停留时间</td> <td style="text-align: left;">sum</td> <td style="text-align: left;">对应的value为累加的值,加1则为1</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">007</td> <td style="text-align: left;">DIY手动生成界面有效停留时间</td> <td style="text-align: left;">sum</td> <td style="text-align: left;">对应的value为累加的值,加1则为1</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">200</td> <td style="text-align: left;">接口请求成功:服务器返回</td> <td style="text-align: left;">none</td> <td style="text-align: left;">无</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">500</td> <td style="text-align: left;">接口请求失败:服务器返回</td> <td style="text-align: left;">none</td> <td style="text-align: left;">无</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">600</td> <td style="text-align: left;">XXX类型错误1</td> <td style="text-align: left;">error</td> <td style="text-align: left;">value用于表示错误信息:气压过低</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">601</td> <td style="text-align: left;">XXX类型错误2</td> <td style="text-align: left;">error</td> <td style="text-align: left;">value用于表示错误信息:机械臂报警</td> <td style="text-align: left;">PC和WeChat</td> </tr> <tr> <td style="text-align: left;">601</td> <td style="text-align: left;">XXX类型错误3</td> <td style="text-align: left;">error</td> <td style="text-align: left;">value用于表示错误信息:雕刻机硬件无法启动</td> <td style="text-align: left;">PC和WeChat</td> </tr> </tbody> </table>

页面列表

ITEM_HTML