Android SDK List

Overview

The Zhuyun IDaaS Open Platform provides various SDK packages for authentication modules to assist Android mobile developers in quickly integrating functions such as login, registration, and biometric authentication.

Latest SDK Packages

Module Name	SDK Package	Latest Version	File Size	Download Link
Common Development Package	AuthnCenter_Common_2E-1.5.3.aar	v.1.5.3	0.1M	Download Here (opens new window)
Password Login	AuthnCenter_PWLogin_2E-1.5.3.aar	v.1.5.3	0.1M	Download Here (opens new window)
SMS Login	AuthnCenter_SMSLogin_2E-1.5.3.aar	v.1.5.3	0.1M	Download Here (opens new window)
Biometric Authentication	AuthnCenter_MFA_BioVerify_2E-1.5.3.aar	v.1.5.3	0.1M	Download Here (opens new window)
Dynamic Password OTP Authentication	AuthnCenter_MFA_OTP-1.5.3.aar	v.1.5.3	0.1M	Download Here (opens new window)

Change Log

Version	Update Time	Update Description
v1.5.3	2022.12.11	Added biometric authentication, SMS, and password login SDKs. The original common package's various business and UI components have been distributed to their respective functional packages. The common package now only includes references to public libraries and utility classes.
v1.4.0	2021.10.11	Fixed known issues, improved SDK stability.

SDK Package Introduction

Common Development Package Introduction

Basic configuration initialization main class AuthnCenterAPI method introduction:

/**
 * SMS Verification Code -- Send SMS
 */
public void smsSend(Context context, SendSmsReq req, RequestListener listener)

/**
 * Get Country Code     Note: If country code configuration is required, this interface must be called to obtain the country code.
 */
public void getCountryCode(Context context, RequestListener listener)

/**
 * Social Account Binding Interface
 * @param context      Context
 * @param stateToken   Temporary token returned after current login
 * @param otpsmsReq    Binding object information
 * @param listener     Event callback
 */
public void socialBind(Context context, String stateToken, OTPSMSReq otpsmsReq, RequestListener listener)

/**
 *  Register
 * @param context      Context
 * @param stateToken   Temporary token returned after current login
 * @param otpsmsReq    Registration object information
 * @param listener     Event callback
 */
public void register(Context context, String stateToken, OTPSMSReq otpsmsReq, RequestListener listener)

/**
 * Parse id_token
 * @param context
 * @param id_token  id_token
 * @param listener  Callback event
 */
public void getUserInfoFromIdToken(Context context, String id_token, CallbackListener listener)

/**
 * Verify id_token
 * @param context Context
 * @param id_token  id_token
 * @param listener  Callback event
 */
public void verifySign(Context context, String id_token, VerifySignListener listener)


/**
 * Refresh token
 *
 * @param context   Context
 * @param sessionToken  sessionToken returned after successful login
 * @param listener Callback event
 */
public void refreshToken(Context context, String sessionToken, RequestListener listener)

/**

• Get user ID via ID token
• @param idToken The idtoken returned after successful login */ public String getUserId(String idToken)

The SDK includes a KeyStore operation utility class, which can be called as needed: KeyStoreUtils.


### Password Login Package Introduction
Introduction to the main class AuthnCenterPWDLogin methods for password login initialization:
```java
/**
 * Username and password login
 *
 * @param context Context
 * @param userName Username
 * @param password Password
 * @param loginListener Event callback
 */
public void userLoginRequest(Context context, String userName, String password, PWLoginListener loginListener)

/**
 * Unified user password login
 *   Supports username+password, mobile number+password, and email+password simultaneously
 * @param context Context
 * @param userName Username
 * @param password Password
 * @param loginListener Event callback
 */
public void userLoginAuthRequest(Context context, String userName, String password, PWLoginListener loginListener)

/**
 * Mobile number + password login
 *
 * @param context Context
 * @param mobile Mobile number
 * @param password Password
 * @param loginListener Event callback
 */
public void userLoginMobilePwd(Context context, String mobile, String password, PWLoginListener loginListener)

/**
 * Email + password login
 *
 * @param context Context
 * @param email Email
 * @param password Password
 * @param loginListener Event callback
 */
public void userLoginEmailPwd(Context context, String email, String password, PWLoginListener loginListener)

/**
 * SMS registration
 *
 * @param context Context
 * @param userInfoReq Registration user entity
 * @param loginListener Event callback
 */
public void userRegister(Context context, UserInfoReq userInfoReq, PWLoginListener loginListener)

/**
 * Password recovery
 *
 * @param context Context
 * @param findPwdReq Password recovery entity
 * @param loginListener Event callback
 */
public void findPwd(Context context, FindPwdReq findPwdReq, PWLoginListener loginListener)

/**
 * Skip password change
 *
 * @param context Context
 * @param stateToken stateToken
 * @param loginListener Event callback
 */
public void skipPwd(Context context, String stateToken, PWLoginListener loginListener)

/**
 * Force password change
 *
 * @param context Context
 * @param pwdReq Password change entity
 * @param stateToken stateToken
 * @param loginListener Event callback
 */
public void updatePwd(Context context, UpdatePwdReq pwdReq, String stateToken, PWLoginListener loginListener)
```
PWLoginListener returns different CODE values during login API callbacks. Integrators need to judge and handle related business logic based on different application scenarios.
Currently, only the following codes are returned for passwords about to expire or already expired. Please refer to the integration DEMO for details.
| <span style="display:inline-block;width:80px">Code Value</span> | <span style="display:inline-block;width:160px">Built-in Enum Value</span> | <span style="display:inline-block;width:160px">Explanation</span> |
| :---------------------------------------------------------- | :----------------------------------------------------------- | :--------------------------------------------------------- |
| 10006                                                       | SDKCodeType.*SDK_PASSWORD_EXPIRED*.getCode()                 | Password has expired                                               |
| 10007                                                       | SDKCodeType.*SDK_PASSWORD_WARN*.getCode()                    | Password is about to expire                                               |

### Introduction to SMS Login Package
Introduction to the main class AuthnCenterSMSLogin method for basic configuration initialization:
```JAVA
/**
 * Built-in sliding verification
 *
 * @param mContext Context
 */
BlockPuzzleDialog mBlockPuzzleDialog = new BlockPuzzleDialog(mContext);
mBlockPuzzleDialog.setOnResultsListener(new OnResultsListener() {
        @Override
        public void onResultsClick(String result) {
            LogUtil.getInstance().d("Secondary verification callback result mCaptchaToken:" + result);
            // This callback result is the captchaToken parameter for SMS verification
        }
        @Override
        public void onError(String code, String msg) {
            ToastUtils.ShowToast(mContext, String.format("Error code: %s  Error message: %s", code, msg));
        }
    });
```

### Introduction to Biometric Authentication Package
Introduction to the built-in APIs of the AuthnCenterMFA package:
~~~java

    /**
     * Get binding status
     * @param context Context
     * @param idToken idtoken
     * @param listener Callback event
     *
     */
    public void getStatus(Context context, String idToken, MFAListener listener);

    /**
     *  Bind device
     * @param context Context
     * @param idToken idtoken
     * @param map Parameters
     * @param listener Callback event
     */
    public void bind(Context context, String idToken, Map map, MFAListener listener);
    /**
     * Unbind device
     * @param context Context
     * @param idToken idtoken
     * @param listener Callback event
     */
    public void unbind(Context context, String idToken, MFAListener listener);

    /**
     *   Query authentication status
     * @param context Context
     * @param idToken idtoken
     * @param listener Callback event
     */
    public void getAuthentication(Context context, String idToken, MFAListener listener) ;

    /**
     *   Query authentication status and perform authentication
     * @param context Context
     * @param idToken idtoken
     * @param ob Callback event
     */
    public void getAuthentication(Context context, String idToken, OnBiometricIdentifyCallback ob);

    /**
     *  Initiate authentication
     * @param context Context
     * @param idToken idtoken
     * @param map Parameter map
     * @param listener Callback event
     */
    public void startAuthentication(Context context, String idToken, Map map, MFAListener listener);

    /**
     *  Initiate authentication including biometric recognition
     * @param context Context
     * @param idToken idtoken
     * @param ob Callback event
     */
    public void startBiometric(Context context, String idToken, OnBiometricIdentifyCallback ob);

    /**
     * Bind/Unbind/Query Biometric Authentication
     * @param context Context
     * @param idToken  idtoken
     * @param bt  Enumeration type
     * @param ob  Callback event
     */
    public void startBiometric(Context context, String idToken, BiometricType bt, OnBiometricIdentifyCallback ob);

    /**
     * Get User ID
     * @param idToken  Idtoken
     * @return
     */
    public String getUserId(String idToken);

Introduction to the Dynamic Password OTP Authentication Package

AuthnCenterOTP Method Introduction:

  /**
     * Add TOKEN
     *
     * @param context Context
     * @param text    Character string after QR code scanning recognition
     */
    public void addToken(Context context, String text)

    /**
     * Delete generated token
     *
     * @param context  Context
     * @param position token index
     */
    public void delToken(Context context, int position)

    /**
     * Edit basic information of an already generated token
     *
     * @param context  Context
     * @param position Index
     * @param issuer   issuer
     * @param label    label
     * @param image    image
     */
    public void editToken(Context context, int position, String issuer, String label, Uri image)

    /**
     * Delete generated token
     *
     * @param context  Context
     * @param position token index
     */
    public void delToken(Context context, int position)

Token is the core generation class.
TokenCode is the time management class.
TokenPersistence is the code management class.
The SDK has a built-in broadcast constant Constant.ACTION_IMAGE_SAVED. When a new OTP is added, a broadcast will be sent. The caller can listen to this broadcast as needed to refresh the list.