UserController.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="content-type" content="text/html;charset=UTF-8">
  5. <style type="text/css">
  6. <!--
  7. @import url(md.css);
  8. -->
  9. </style></head><body>
  10. <p>用户 </p>
  11. <h1 id="/sbl/user/reg/v1_POST">1 APP注册</h1>
  12. <p>APP注册</p>
  13. <h2>1.1 请求部分<h2>
  14. <ul><li><p>接口URI</p> <pre><code>/sbl/user/reg/v1 POST</code></pre></li><li><p>接口参数</p>
  15. <pre><code>String phone
  16. String password
  17. String verifyCode 验证码
  18. String regIMEI 设备识别码。手机的IMEI码,通常36字内。
  19. String appMarket 应用市场名称. 2019-08-06 【len=16,可空】
  20. </code></pre></li></ul>
  21. <h2>1.2 响应部分</h2> <p>用户的基本数据</p>
  22. <hr>
  23. <h1 id="/sbl/user/reg/del/v1_POST">2 注销用户账号</h1>
  24. <p>注销用户账号
  25. <p>注销验证码重用注册的验证码接口。</p>
  26. <p>注销操作是在手机帐号尾后加"X"字符。成功注销后,不可以登录。</p></p>
  27. <h2>2.1 请求部分<h2>
  28. <ul><li><p>接口URI</p> <pre><code>/sbl/user/reg/del/v1 POST</code></pre></li><li><p>接口参数</p>
  29. <pre><code>String key 当前登录标识
  30. String verifyCode 验证码
  31. String reason 注销的原因
  32. </code></pre></li></ul>
  33. <h2>2.2 响应部分</h2> <p><p>注销操作是否成功的结果</p>
  34. <p>code=200代表注销操作执行成功</p>
  35. <p>其它值是执行失败,并提示注销失败的原因</p></p>
  36. <hr>
  37. <h1 id="/sbl/user/login/v1_POST">3 旧 登录</h1>
  38. <p>旧 登录</p>
  39. <h2>3.1 请求部分<h2>
  40. <ul><li><p>接口URI</p> <pre><code>/sbl/user/login/v1 POST</code></pre></li><li><p>接口参数</p>
  41. <pre><code>String phone
  42. String password
  43. </code></pre></li></ul>
  44. <h2>3.2 响应部分</h2> <p>返回用户的基本数据 和 参保人列表</p>
  45. <hr>
  46. <h1 id="/sbl/user/login/v2_POST">4 登录v2</h1>
  47. <p>登录v2
  48. <li>2019-03-06, 增加返回帐号注册年(reg_y)</li>
  49. <li>2017-06-01, 身份证打星号</li></p>
  50. <h2>4.1 请求部分<h2>
  51. <ul><li><p>接口URI</p> <pre><code>/sbl/user/login/v2 POST</code></pre></li><li><p>接口参数</p>
  52. <pre><code>String phone
  53. String password
  54. </code></pre></li></ul>
  55. <h2>4.2 响应部分</h2> <p>返回用户的基本数据 和 参保人列表(参保人的身份证号模糊显示)<br>
  56. 2019-03-06, 增加返回帐号注册年(reg_y)</p>
  57. <hr>
  58. <h1 id="/sbl/user/head/v1_POST">5 更改头像接口</h1>
  59. <p>更改头像接口</p>
  60. <h2>5.1 请求部分<h2>
  61. <ul><li><p>接口URI</p> <pre><code>/sbl/user/head/v1 POST</code></pre></li><li><p>接口参数</p>
  62. <pre><code>String key
  63. String head_img
  64. </code></pre></li></ul>
  65. <h2>5.2 响应部分</h2> <p>更改的结果是否成功。</p>
  66. <hr>
  67. <h1 id="/sbl/user/change/phone/v1_POST">6 更换手机号</h1>
  68. <p>更换手机号</p>
  69. <h2>6.1 请求部分<h2>
  70. <ul><li><p>接口URI</p> <pre><code>/sbl/user/change/phone/v1 POST</code></pre></li><li><p>接口参数</p>
  71. <pre><code>String key
  72. String phone
  73. String verify_code
  74. </code></pre></li></ul>
  75. <h2>6.2 响应部分</h2> <p>换手机号是否成功</p>
  76. <hr>
  77. <h1 id="/sbl/user/change/psw/v1_POST">7 修改密码</h1>
  78. <p>修改密码</p>
  79. <h2>7.1 请求部分<h2>
  80. <ul><li><p>接口URI</p> <pre><code>/sbl/user/change/psw/v1 POST</code></pre></li><li><p>接口参数</p>
  81. <pre><code>String key
  82. String prePassword
  83. String password
  84. </code></pre></li></ul>
  85. <h2>7.2 响应部分</h2> <p>修改密码是否成功</p>
  86. <hr>
  87. <h1 id="/sbl/user/find/psw/v1_POST">8 短信找回密码</h1>
  88. <p>短信找回密码</p>
  89. <h2>8.1 请求部分<h2>
  90. <ul><li><p>接口URI</p> <pre><code>/sbl/user/find/psw/v1 POST</code></pre></li><li><p>接口参数</p>
  91. <pre><code>String phone
  92. String password
  93. String verify_code
  94. </code></pre></li></ul>
  95. <h2>8.2 响应部分</h2> <p>找回密码处理是否成功。</p>
  96. <hr>
  97. <h1 id="/sbl/user/list/msg/v1_POST">9 用户未读的消息列表</h1>
  98. <p>用户未读的消息列表</p>
  99. <h2>9.1 请求部分<h2>
  100. <ul><li><p>接口URI</p> <pre><code>/sbl/user/list/msg/v1 POST</code></pre></li><li><p>接口参数</p>
  101. <pre><code>String key
  102. </code></pre></li></ul>
  103. <h2>9.2 响应部分</h2> <p>返回消息数据的列表。</p>
  104. <hr>
  105. <h1 id="/sbl/user/msg/count/v1_POST">10 需要用户关注的功能点标数字</h1>
  106. <p>需要用户关注的功能点标数字
  107. <li>2019-03-07 增加有流水待付款,未配置银行卡的参保人Id</li></p>
  108. <h2>10.1 请求部分<h2>
  109. <ul><li><p>接口URI</p> <pre><code>/sbl/user/msg/count/v1 POST</code></pre></li><li><p>接口参数</p>
  110. <pre><code>String key
  111. </code></pre></li></ul>
  112. <h2>10.2 响应部分</h2> <ul><li> 响应字段
  113. <pre><code>int msg 未读消息数
  114. int buy 未付款买单数
  115. int added 未付款补差额单数
  116. int wage 未付款社保流水单数
  117. List<Integer> sbuids 未配置银行卡的参保人Id列表 2019-03-07
  118. int material_flow 未查看过的待办事项数。
  119. </code></pre></li></ul> <p>json字符串。</p>
  120. <hr>
  121. <h1 id="/sbl/user/address/v1_POST">11 获取用户收件地址</h1>
  122. <p>获取用户收件地址</p>
  123. <h2>11.1 请求部分<h2>
  124. <ul><li><p>接口URI</p> <pre><code>/sbl/user/address/v1 POST</code></pre></li><li><p>接口参数</p>
  125. <pre><code>String key
  126. </code></pre></li></ul>
  127. <h2>11.2 响应部分</h2> <ul><li> 响应字段
  128. <pre><code>int u_id
  129. String u_name
  130. String phone
  131. String area
  132. String address
  133. </code></pre></li></ul> <p></p>
  134. <hr>
  135. <h1 id="/sbl/user/address/edit/v1_POST">12 修改用户的收件地址</h1>
  136. <p>修改用户的收件地址</p>
  137. <h2>12.1 请求部分<h2>
  138. <ul><li><p>接口URI</p> <pre><code>/sbl/user/address/edit/v1 POST</code></pre></li><li><p>接口参数</p>
  139. <pre><code>String key
  140. String u_name 收件人
  141. String phone 联系电话
  142. String area 区域编码
  143. String address 地址
  144. </code></pre></li></ul>
  145. <h2>12.2 响应部分</h2> <p>是否成功修改</p>
  146. <hr>
  147. <h1 id="/sbl/user/address/delete/v1_POST">13 删除收件地址</h1>
  148. <p>删除收件地址</p>
  149. <h2>13.1 请求部分<h2>
  150. <ul><li><p>接口URI</p> <pre><code>/sbl/user/address/delete/v1 POST</code></pre></li><li><p>接口参数</p>
  151. <pre><code>String key
  152. </code></pre></li></ul>
  153. <h2>13.2 响应部分</h2> <p>是否成功删除</p>
  154. <hr>
  155. <h1 id="/sbl/user/device/flag/v1_POST">14 记录用户的设备标识号和应用商店号 </h1>
  156. <p>记录用户的设备标识号和应用商店号
  157. <li>2019-08-01 </li>
  158. <li>调用:1. 打开APP无历史key时;2. 注册成功时;3. 有历史key重新登录成功时调用。</li>
  159. <li>游客打开APP: key="", 其它参数提供值;游客进入小程序:key="", phoneFlag=openId,appPlatform=约定值</li>
  160. <li>游客注册成功:参数都提供有效值</li>
  161. <li>登录用户: 参数都提供有效值(key=重新登录成功后的key)</li></p>
  162. <h2>14.1 请求部分<h2>
  163. <ul><li><p>接口URI</p> <pre><code>/sbl/user/device/flag/v1 POST</code></pre></li><li><p>接口参数</p>
  164. <pre><code>String key 用户登录标识。为空表明是游客
  165. String phoneFlag 手机设备标识,; 小程序传openId。【不可空 len=36】
  166. String appPlatform 应用市场平台标识。H5传合作渠道英文标识。【不可空 len=16】
  167. </code></pre></li></ul>
  168. <h2>14.2 响应部分</h2> <p>code=200是成功;其它值未成功。</p>
  169. <hr>
  170. <script src="md.js"></script></body></html>