开发
API
自2022年9月6日起,本文档站不再更新内容,相关文档已迁移至全新“抖音开放平台”前往

tt.showDouyinOpenAuth

基础库 1.93.0 开始支持本方法,这是一个异步方法。

提供小程序获取抖音权限的能力,展示出抖音权限授权弹窗。在使用接口前,需要小程序拥有者前往抖音开放平台-管理中心-应用管理申请开通小程序需要的权限。下图以开通视频发布权限为例。

语法

tt.showDouyinOpenAuth(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
scopesobject需要获取权限的信息,详情见 scopes 说明1.93.0
successfunction接口调用成功后的回调函数1.93.0
failfunction接口调用失败后的回调函数1.93.0
completefunction接口调用结束后的回调函数(调用成功、失败都会执行)1.93.0

scopes 说明

scopes 是 object 类型,其中 key 值是申请权限的 scope,详见用户授权 scope 列表。value 的合法值见下表。注意:此处申请的权限在抖音开放平台必须是已开通状态。

说明最低支持版本
0必选项(用户无法取消)1.93.0
1非必选,默认选中1.93.0
2非必选,默认不选中1.93.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring回调信息1.93.0
ticketstring请求授权返回的票据,详情见 ticket 说明1.93.0
grantPermissionsstring[]用户授权的权限1.93.0

ticket 说明

ticket 是临时票据,是用来从开放平台的接口(点击进入接口详情)获取用户的长期票据 access_token 的。开放平台的授权流程示意图如下:

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errNonumber错误码1.93.0
errMsgstring错误信息1.93.0

错误说明

errNoerrMsg说明最低支持版本
10301feature is not supported in app宿主不支持登录/宿主不支持抖音开放平台授权1.93.0
21100login fail xxx用户登录失败1.93.0
21101request auth ticket fail xxx获取权限票据失败1.93.0
21102request auth scope info fail xxx获取权限信息失败1.93.0
21103request auth code fail xxx获取权限授权码失败1.93.0
20000scopes is empty开发者传入的 scopes 为空数据1.93.0
21104no usage scope没有可用的授权权限(开发者申请授权的权限全都没有被开通)1.93.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.showDouyinOpenAuth({
  scopes: {
    "following.list": 1,
    "fans.list": 1,
    "item.comment": 1,
  },
  success(res) {
    console.log("success", res);
  },
  fail(res) {
    console.log("fail", res);
  },
  complete(res) {
    console.log("complete", res);
  },
});

Bug & Tip

  • Tip:该接口只支持抖音,所以请在抖音 APP 中调用;
  • Tip:每次申请授权都是该小程序的抖音权限全量授权,请在传入 scopes 时,把需要的授权的 scopes 都传入。由于不支持增量授权,即使用户已经授权过部分抖音权限,也还是需要全量传入所有需要的权限;
  • Tip:每次申请授权的抖音权限必须是在抖音开发平台已经申请并且审批开通的权限,否则会导致本次授权操作失败;
  • Tip:此处授权是抖音相关的授权,如果想要申请小程序授权,请查看 tt.authorize。这两处授权的 scopes 范围不同;
  • Tip:在请求服务端接口时,应用唯一标识在小程序场景下,对应的是小程序 appId应用唯一标识对应的密钥对应的是小程序的 APP Secret
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助