template_api.tpl 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. #### 简要描述:
  2. - 用户登录接口
  3. #### 接口版本:
  4. |版本号|制定人|制定日期|修订日期|
  5. |:---- |:---|:----- |----- |
  6. |2.1.0 |秦亮 |2017-03-20 | xxxx-xx-xx |
  7. #### 请求URL:
  8. - http://xx.com/api/login
  9. #### 请求方式:
  10. - GET
  11. - POST
  12. #### 请求头:
  13. |参数名|是否必须|类型|说明|
  14. |:---- |:---|:----- |----- |
  15. |Content-Type |是 |string |请求类型: application/json |
  16. |Content-MD5 |是 |string | 请求内容签名 |
  17. #### 请求参数:
  18. |参数名|是否必须|类型|说明|
  19. |:---- |:---|:----- |----- |
  20. |username |是 |string |用户名 |
  21. |password |是 |string | 密码 |
  22. #### 返回示例:
  23. **正确时返回:**
  24. ```
  25. {
  26. "errcode": 0,
  27. "data": {
  28. "uid": "1",
  29. "account": "admin",
  30. "nickname": "Minho",
  31. "group_level": 0 ,
  32. "create_time": "1436864169",
  33. "last_login_time": "0",
  34. }
  35. }
  36. ```
  37. **错误时返回:**
  38. ```
  39. {
  40. "errcode": 500,
  41. "errmsg": "invalid appid"
  42. }
  43. ```
  44. #### 返回参数说明:
  45. |参数名|类型|说明|
  46. |:----- |:-----|----- |
  47. |group_level |int |用户组id,1:超级管理员;2:普通用户;3:只读用户 |
  48. #### 备注:
  49. - 更多返回错误代码请看首页的错误代码描述