接口描述:

  • 账号登录,并且获取授权码。

请求 URL:

  • http|https://host/api/v1/admin/method/login.admin.user/

请求方式:

  • GET
  • POST

是否授权:

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
username string length:4,20 admin 账号
password string min:6 admin888 密码
platform string max:50 ios 来源平台,该字段值由客户端指定

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
admin object [] 账号对象
token object [] 授权对象
admin 类型 是否返回 示例值 描述
admin_id integer 1 账号编号
username string admin 账号
group_id integer 1 所属用户组
nickname string carey 昵称
head_pic string //host/head_pic.jpg 头像
last_login datetime 2018-04-23 00:12:04 最后登陆时间
last_ip string 127.0.0.1 最后登录ip
status integer 1 是否启用 0=禁用 1=启用
create_time datetime 2018-04-22 00:23:00 创建时间
update_time datetime 2018-04-22 01:56:55 更新时间
token 类型 是否返回 示例值 描述
group_id integer 1 所属用户组
token string - 授权码
token_expires timestamp 1527005172 授权码过期时间,时间戳
refresh string - 刷新授权码,可用来刷新 token
refresh_expires timestamp 1527091572 刷新授权码过期时间,时间戳

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "admin": {
  6. "admin_id": 1,
  7. "username": "admin",
  8. "group_id": 1,
  9. "nickname": "carey",
  10. "head_pic": "//host/head_pic.jpg",
  11. "last_login": "",
  12. "last_ip": "",
  13. "status": 1,
  14. "create_time": "2018-04-22 00:23:00",
  15. "update_time": "2018-04-22 01:56:55"
  16. },
  17. "token": {
  18. "group_id": 1,
  19. "token": "3147ed7851354e0056c67a1ea1f249e1",
  20. "token_expires": 1527005172,
  21. "refresh": "4f2780e64fce73f21e4f2c16adeca7d2",
  22. "refresh_expires": 1527091572
  23. }
  24. }
  25. }

备注:

  1. platform示例说明:假设有二台 IOS 设备,A 设备已登录账号 admin,现在使用账号 admin 再去登录 B 设备,则 A 设备上的授权码将无效,而 Web 或 Android 平台上的账号不会受此影响。

  2. 获取到token之后,调用需要授权的接口时,需要将该值进行传递,与公共参数中的token对应。

  3. tokenrefresh都有过期时间,在未过期期间内如果需要增长授权时间可调用接口 刷新Token

  4. tokenrefresh的值固定为 32 个十六进制字符的长度,并且是小写字母。

  5. 获取到最新的token后,之前的token将失效。

文档更新时间: 2018-08-04 00:14