• 下载
  • 社区

my.getAuthCode

获取授权码。更多介绍信息请参见 用户授权

相关问题请参见 用户授权 FAQ 。


注意:

  • 请勿在小程序的可重复触发的生命周期(例如 onShow)中调用 my.getAuthCode授权弹窗的消失会触发小程序的 onShow 事件接入方未对是否已展现过授权做标识与逻辑判断,引起重复触发授权。
  • 为了创造更良好的支付宝小程序用户体验,在小程序的首屏引导用户授权是不被允许的。需要在用户充分了解小程序的业务内容后再引导用户授权,建议将小程序授权环节放在业务流程中。
  • 小程序 不支持 使用拼接授权链接进行授权,建议使用 my.getAuthCode 实现用户授权、用户登录等。


扫码体验

my.getauthcode.jpeg


示例代码

// 示例一
my.getAuthCode({
  scopes: 'auth_user',
  success: (res) => {
    my.alert({
      content: res.authCode,
    });
  },
});

// 示例二
my.getAuthCode({
  scopes: ['auth_user'],
  success: (res) => {
    my.alert({
      content: res.authCode,
    });
  },
});


入参

Object 类型,属性如下:

属性

类型

必填

描述

scopes

String/Array

授权类型,默认 auth_base。支持 auth_base(静默授权)/ auth_user(主动授权)/

auth_zhima (获取用户芝麻信息)

success

Function

调用成功的回调函数。

fail

Function

调用失败的回调函数。

complete

Function

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


scopes 说明

一个 scope 表示开发者需要请求用户授权的权限范围,一个 scope 包含至少一个 OpenAPI 接口或者 JSAPI 接口,一次授权可以组合多个 scope 做组合授权,用“,”分隔。


scopes

说明

包含的openapi接口

auth_base

静默授权。用户基础授权,仅用于静默获取用户支付宝uid。静默授权不弹框,直接获取用户信息。

auth_user

网站支付宝登录;获取用户信息(现已升级为“获取会员基础信息”,且新功能包不再使用 alipay.user.info.share 接口)

alipay.user.info.share

auth_zhima

用户芝麻信息。

zhima.credit.score.brief.get


success 回调函数

名称

类型

描述

authCode

String

授权码

authErrorScopes

Key-Value

失败的授权类型,key 是授权失败的 scope,value 是对应的错误码

authSucessScopes

Array

成功的授权 scope