Authing DocsDocuments
Concept
workflow
Guides
Development Integration
Application integration
Concept
workflow
Guides
Development Integration
Application integration
Old Version
Development Integration
  • Single Sign-On (SSO)
  • Login component

  • JavaScript/Node.js

  • Java / Kotlin

  • Python

  • C#

  • PHP

  • Go

  • Ruby
  • Android

    • Quick start
    • Hosting page
    • APIs

    • Third-party identity source

      • Wechat
      • Alipay
      • Google
      • Facebook
      • Wechat MiniProgram
      • QQ
      • Weibo
      • Baidu
      • Linkedin
      • Github
      • Gitee
      • GitLab
      • Douyin
      • Kuaishou
      • Huawei
      • OPPO
      • Xiaomi
      • Line
      • Slack
      • Amazon
      • Wecom
      • Lark
      • DingTalk
    • Scenario

    • On-premise
    • Android Guard Change log
    • Error code
  • iOS

  • Flutter

  • React Native
  • WeChat Mini Program
  • WeChat webpage authorization
  • Framework Integration
  • Error code
  1. Development Integration
  2. /
  3. Android
  4. /
  5. Third-party identity source
  6. /
  7. Wechat MiniProgram

¶ Login by Wehcat Miniprogram

Update Time: 2025-05-14 08:32:28
Edit

¶ Preparatory work

Configure in Wechat open platform (opens new window) and Authing Console (opens new window) , See APP 拉起微信小程序,Mobile apps need to be associated with small programs.

This feature was added in android guard sdk 1.4.8 version.


¶ Integrate steps

¶ Step 1:Add dependency

implementation 'cn.authing:guard:+'
implementation 'com.tencent.mm.opensdk:wechat-sdk-android:6.8.0'

The Guard compileOnly relies on gms, which allows apps to import on demand, preventing the Guard aar package from getting bigger as more third party logins are supported. Therefore, every time a third-party identity source is added, the App needs to manually add the dependency of the identity source.

¶ Step 2:Initialization

To initialize Guard Android SDK when the application starts:

// context is application or initial activity
// ”AUTHING_APP_ID“ is obtained from the Authing console
Authing.init(context, "AUTHING_APP_ID");
Authing.setAuthProtocol(Authing.AuthProtocol.EOIDC)

¶ Step 3:create WXEntryActivity

According to wechat rules, developer MUST create an Activity called WXEntryActivity and it MUST be put under a package call 'wxapi' and further more, the 'wxapi' package MUST be under your application's package directly. Here is an example, suppose your android application package is:

com.example.myapp

Then you need to create WXEntryActivity like this:

Good news is that the content of this WXEntryActivity is really simple, since we already did the heavy lifting, all you need to do is to extend our Activity, like this:

package com.example.myapp.wxapi;

import cn.authing.guard.social.callback.wechat.WXCallbackActivity;

public class WXEntryActivity extends WXCallbackActivity {
}

¶ Step 4:We need to declare this Activity in Manifest

Add the exported, taskAffinity and launchMode attributes to the manifest file with exported set to true and taskAffinity set to the name of your package, launchMode is set to singleTask, such as:

<activity
    android:name=".wxapi.WXEntryActivity"
    android:exported="true"
    android:taskAffinity="packge name"
    android:launchMode="singleTask"/>

Precautions

If you need to obfuscate code, add the following configuration to proguard.cfg to ensure proper use of the sdk:

-keep class com.tencent.mm.opensdk.** {
    *;
}

-keep class com.tencent.wxop.** {
    *;
}

-keep class com.tencent.mm.sdk.** {
    *;
}

¶ Step 5:Specification of the wechat miniprogram callback data format

The format of the data (extMsg) that the wechat miniprogram calls back to the APP should be restricted as follows:

{
  "code": "001x691w398h8039gl0w3ERdyy1x691y",
  "phoneInfoCode": "geC88uOGAkjOeziTDu/iJA==",
}

The APP will get the data in the callback of WXEntryActivity :

public void onResp(BaseResp resp) {
    if (resp.getType() == ConstantsAPI.COMMAND_LAUNCH_WX_MINIPROGRAM) {
        WXLaunchMiniProgram.Resp launchMiniProResp = (WXLaunchMiniProgram.Resp) resp;
        String extraData =launchMiniProResp.extMsg;
    }
}

¶ Step 6:Use in different scenarios

  • ¶ Use in different scenarios

    Start the managed page where login authentication is required:
// this is the activity context
AuthFlow.start(this);

By following the preceding steps, you can quickly and easily configure the Authing management console to automatically have the wehcat miniprogram login function. The login entry is displayed in the social login button list on the built-in login interface of the Guard.

  • ¶ Use the login by wehcat miniprogram sign In button

    If you use the miniprogram login button we provide.

​ 1. Add the following code to the layout file:

 <cn.authing.guard.social.view.WechatMiniProgramLoginButton
    android:id="@+id/btn_login"
    android:background="@drawable/authing_button_background"
    android:textColor="@color/white"
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

​ 2. Then handle the event in the code:

WechatMiniProgramLoginButton button = findViewById(R.id.btn_login);
button.setOnLoginListener(new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
      	if (code == 200) {
        	// login success, data is user info.
       	} else {
        	// login fail
      	}
    }
});
  • ¶ Log in to the authorization class using WechatMiniProgram

    If you don't want to use our built-in buttons and want to implement the UI entirely yourself, you can call the WechatMiniProgram class authorization function inside the button click event, which integrates the business logic to pull up the miniprofram authorization login:
WechatMiniProgram wechatMiniProgram = new WechatMiniProgram();
wechatMiniProgram.login(appContext, new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
        if (code == 200) {
        	// login success, data is user info.
       	} else {
        	// login fail
      	}
    }
});

​ data contains idToken and user information (user name, nickname, name, etc.).

  • ¶ Log into the API using miniprogram

    If you want to fully implement the miniprogram login UI and obtain the authorization code logic yourself, after obtaining the authorization code, you can call the following API in exchange for user information:

public static void loginByWechatMiniProgram(String code, String phoneInfoCode, @NotNull AuthCallback<UserInfo> callback)

param

  • code The user code returned by the wx.login interface

  • phoneInfoCode Small program to obtain the user phone number returned code

example

If you only need to get the user information (username, nickname, name, etc.) and idToken, call:

AuthClient.loginByWechatMiniProgram(code, phoneInfoCode, new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
        if (code == 200) {
          // login success, data is user info, contains idToken.
        } else {
          // login fail
        }
    }
});

If you only need to get the user information (username, nickname, name, etc.) and idToken、accessToken 和 refreshToken,call:

OIDCClient oidcClient = new OIDCClient();
oidcClient.loginByWechatMiniProgram(code, phoneInfoCode, new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
        if (code == 200) {
          // ogin success, data is user info, contains idToken、accessToken and refreshToken.
        } else {
          // login fail
        }
    }
});
Prev: Facebook Next: QQ
  • Preparatory work
  • Integrate steps

User identity management

Integrated third-party login
Mobile phone number flash check (opens new window)
Universal login form component
Custom authentication process

Enterprise internal management

Single Sign On
Multi-factor Authentication
Authority Management

Developers

Development Document
Framework Integration
Blog (opens new window)
GitHub (opens new window)
Community User Center (opens new window)

Company

400 888 2106
sales@authing.cn
16 / F, Block B, NORTH STAR CENTURY CENTER, Beijing(Total)
room 406, 4th floor, zone B, building 1, No. 200, Tianfu Fifth Street, Chengdu(branch)

Beijing ICP No.19051205-1

© Beijing Steamory Technology Co.