menu MDClub JavaScript SDK 文档

TokenApi.login

通过账号密码登陆,返回 Token 信息。

若登录失败,且返回信息中含参数 captcha_tokencaptcha_image, 表示下次调用该接口时,需要用户输入图形验证码,并把 captcha_tokencaptcha_code 参数传递到服务端。

方法定义

TokenApi.login(param: LoginParams): Promise<TokenResponse>

参数

LoginParams TokenApi.ts:8

参数名必选类型说明
captcha_codestring

图形验证码的值。若上一次请求返回了 captcha_token,则必须传该参数

captcha_tokenstring

图形验证码token。若上一次请求返回了 captcha_token, 则必须传该参数

devicestring

设备信息

namestring

用户名或邮箱

passwordstring

经过 hash1 加密后的密码。

  • 若你使用的是 mdclub-sdk-js,则 SDK 内部已经实现了 sha1 加密,该参数直接传入明文密码即可。
  • 若你直接调用 REST API,则需要自己实现 sha1 加密。

响应

TokenResponse models.ts:1858

参数名类型说明
codenumber

无任何错误时,状态码为 0

dataToken

Token models.ts:1831

参数名类型说明
create_timenumber

创建时间

devicestring

设备信息

expire_timenumber

过期时间

tokenstring

Token 字符串

update_timenumber

更新时间

user_idnumber

用户ID