登录

延长已有Token的有效时间

接口说明

默认情况下Token的有效期为21天,此接口用于在此期间延长一个有效的JWT Token的有效时间。

权限需求

此接口需要登录后才可使用(请求中包含Authorization头)

返回值说明

调用此接口后相当于重新使用当前用户的信息进行重新登录,将会返回最新的用户信息(包括已延长有效期的JWT Token)。 如果应用或用户的状态异常,将会返回相应的错误代码。

get/api/v2/login/renew

Request

  • Base URL: https://api.dandanplay.net
  • URL: https://api.dandanplay.net/api/v2/login/renew
  • Auth: one of:
    • API key in header X-AppId
    • API key in header X-AppSecret
    • HTTP bearer

Response

返回Token刷新后的用户信息

errorCodeinteger

错误代码,0表示没有发生错误,非0表示有错误,详细信息会包含在errorMessage属性中

successboolean

接口是否调用成功

errorMessagestring nullable

当发生错误时,说明错误具体原因

errorDetailstring nullable

当参数校验失败时,提供可供调用方定位问题字段的补充信息。

registerRequiredboolean

该用户是否需要先注册弹弹play账号才可正常登录。当此值为true时表示用户使用了QQ微博等第三方登录但没有注册弹弹play账号。

userIdinteger

用户编号

userNamestring nullable

弹弹play用户名。如果用户使用第三方账号登录(如QQ微博)且没有关联弹弹play账号,此属性将为null

emailstring nullable

用户邮箱地址

legacyTokenNumberinteger

旧API中使用的数字形式的token,仅为兼容性设置,不要在新代码中使用此属性

tokenstring nullable

字符串形式的JWT token。将来调用需要验证权限的接口时,需要在HTTP Authorization头中设置“Bearer token”。

tokenExpireTimestring date-time

JWT token过期时间,默认为21天。如果是APP应用开发者账号使用自己的应用登录则为1年。

userTypestring nullable

用户注册来源类型

screenNamestring nullable

昵称

profileImagestring nullable

头像图片的地址

appScopestring nullable

当前登录会话内应用权限列表,可以由此判断能否调用哪些API

codestring nullable

消息体验证码

tsinteger

当前时间戳

Changes

No recorded changes to this operation across all 1 revision of this API.