开发
API

tt.login

基础库 1.0.0 开始支持本方法。该 API 为异步 API。

调用该 API 可以获取用户临时的登录凭证。

语法

tt.login(options);

参数说明

options 为 object 类型,属性如下:

属性名

类型

默认值

必填

说明

最低支持版本

force

boolean

true

未登录时, 是否强制调起登录框

1.0.0

success

Function


接口调用成功的回调函数

1.0.0

complete

Function


接口调用结束的回调函数(调用成功、失败都会执行)

1.0.0

fail

Function


接口调用失败的回调函数

1.0.0

回调成功

object 类型,属性如下:

属性名

类型

说明

最低支持版本

errMsg

string

"login:ok"

1.0.0

code

string

临时登录凭证, 有效期 5 分钟。开发者可以通过在服务器端调用 登录凭证校验接口 换取 openid 和 session_key 等信息。

1.0.0

anonymousCode

string

用于标识当前设备, 无论登录与否都会返回, 有效期 5 分钟。

1.0.0

isLogin

boolean

判断在当前 APP(头条、抖音等)是否处于登录状态。

1.0.0

回调失败

object 类型,属性如下:

属性名

类型

说明

最低支持版本

errMsg

string

"login:fail " + 详细错误信息

1.0.0

代码示例

tt.login({
  force: true,
  success(res) {
    console.log(`login 调用成功${res.code} ${res.anonymousCode}`);
  },
  fail(res) {
    console.log(`login 调用失败`);
  },
});

Bug & Tip

  • Tip:forcetrue 时(默认值为 true), 如果用户未在端登录(例如未在头条 App 登录), 则会调起端的登录窗口, 如果用户点击取消则会调用 fail
  • Tip:只有端登录的用户 success 才有 code, 否则只有 anonymousCode
  • Tip:code 可以换取 openid, openid 是用户的唯一标识
  • Tip:anonymousCode 可以换取 anonymous_openid, 同一台手机 anonymous_openid 是相同的
点击纠错
评价此篇文档