接口描述:

  • 登录账号。

请求 URL:

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

请求方式:

  • GET
  • POST

是否授权:

业务参数:

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

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
user object [] 账号对象
token object [] 授权对象
user 类型 是否返回 示例值 描述
user_id integer 18 账号编号
username string carey 账号
mobile number 888888 手机号
is_mobile integer 0 手机号是否验证 0=否 1=是
email string admin@admin.cn 邮箱
is_email integer 0 邮箱是否验证 0=否 1=是
nickname string carey 昵称
head_pic string //host/head_pic.jpg 头像
sex integer 0 性别 0=保密 1=男 2=女
birthday date 1997-11-20 生日
user_level_id integer 1 账号等级编号
user_address_id integer 1 默认收货地址编号
group_id integer 3 所属用户组
last_login datetime 2018-04-22 00:23:00 最后登陆时间
last_ip string 127.0.0.1 最后登录ip
status integer 1 是否启用 0=禁用 1=启用
create_time datetime 2018-04-23 13:12:22 创建时间
update_time datetime 2018-04-23 16:28:45 更新时间
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. "user": {
  6. "user_id": 18,
  7. "username": "dnyz529",
  8. "mobile": "15867430425",
  9. "is_mobile": 1,
  10. "email": "",
  11. "is_email": 0,
  12. "nickname": "",
  13. "head_pic": "",
  14. "sex": 0,
  15. "birthday": "",
  16. "user_level_id": 1,
  17. "user_address_id": 0,
  18. "group_id": 3,
  19. "last_login": "",
  20. "last_ip": "",
  21. "status": 1,
  22. "create_time": "2018-06-18 23:02:44",
  23. "update_time": "2018-06-18 23:02:44"
  24. },
  25. "token": {
  26. "group_id": 3,
  27. "token": "d518ba75422b07a28ead3a37ec43f5ec",
  28. "token_expires": 1531927335,
  29. "refresh": "f4cd0973451f40bd07d46716b311909f",
  30. "refresh_expires": 1532013735
  31. }
  32. }
  33. }

备注:

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

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

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

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

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

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