一、使用说明

基于Oauth 2.0协议，提供基于系统小米账号的一键登录、授权登录能力

二、开发流程

三、使用约束

国内小米设备、最低支持Android 11

四、开发步骤

1、添加 App Id 和构建版本 Debug 标识

在应用的 AndroidManifest.xml 中添加 meta-data 配置

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <application>
       
        <meta-data
            android:name="com.xiaomi.xms.APP_ID"
            android:value="your app id here" />
            
        <meta-data
            android:name="com.xiaomi.xms.BUILD_TYPE_DEBUG"
            android:value="true or false" />
   
    </application>
</manifest>

App Id
com.xiaomi.xms.APP_ID
当开通服务时，会生成 App Id 唯一标识，用于鉴权
必须配置 App Id，调用服务时会通过 App Id 进行鉴权
构建版本 Debug 标识
com.xiaomi.xms.BUILD_TYPE_DEBUG
当前 APK 是否为 Debug 构建版本。若不配置，默认为 false
鉴权时会验证应用 apk 签名。开发调试阶段，一般不会运行 Release 签名的 apk，通常都是运行 Debug 签名 apk，为了保证在开发阶段仍然可以鉴权成功，开发者可以在平台同时添加正式证书指纹（Release 签名）和测试证书指纹（Debug 签名），用于不同场景下鉴权。

五、接口说明/API参考文档/调用方式说明

说明：每个接口有一个示例（处理完整，包括传参、正确和错误的返回值、打印等）

1、API接口文档

（1）接口概述

入口类：com.xiaomi.ecosys.account.MiAccount

主要结构体

（2）API接口明细

1. 校验登录环境

boolean loginSupport = MiAccount.getInstance().checkLoginSupport(this, 0);

2. 一键登录

// 登录回调
private final LoginCallback callback = new LoginCallback() {
    @Override
    public void onSuccess(String authCode, String state, String nonce) {
        //登录完成
    }

    @Override
    public void onCancel() {
        //登录取消
    }

    @Override
    public void onLoginOther() {
        //其他登录方式
    }

    @Override
    public void onFail(int errorCode, int subErrorCode, String errorMsg, String subErrMessage) {
        //登录失败
    }
};

//一键登录
public void quickLoginWithPhone() {
    OAuthQuickLoginParam quickLoginParam = new OAuthQuickLoginParam.Builder()
            .clientId("28xxxxxxxxx") //小米开放平台中注册应用后可直接获取
            .loginType(1) // 登录方式，1:小米账号一键登录；2:授权登录
            .state("xxxxx") //透传字段 开发者可自定义，字符包含0-9、a-z、A-Z、点号、冒号、斜杠、下划线等，长度限制1-255，校验规则^[0-9a-zA-Z:/\.\-_]{1,255}$
            .nonce("xxxxxxx") //透传字段 开发者可自定义，字符包含0-9、a-z、A-Z、点号、冒号、斜杠、下划线等，长度限制1-255，校验规则^[0-9a-zA-Z:/\.\-_]{1,255}$
            .privacyUrl("https://XXXX.com/XXXXX/") // 隐私政策链接地址
            .privacyText("XXXXX隐私协议") // 隐私政策文案
            .userAgreementUrl("https://XXXX.com/XXXXXX") //用户协议链接地址
            .userAgreementText("XXXX用户协议") //用户协议文案
            .build();
    MiAccount.getInstance().login(this, quickLoginParam, callback);
}

3. 授权登录

// 登录回调
private final LoginCallback callback = new LoginCallback() {
    @Override
    public void onSuccess(String authCode, String state, String nonce) {
        //登录完成
    }

    @Override
    public void onCancel() {
        //登录取消
    }

    @Override
    public void onLoginOther() {
        //其他登录方式
    }

    @Override
    public void onFail(int errorCode, int subErrorCode, String errorMsg, String subErrMessage) {
        //登录失败
    }
};

//一键登录
public void quickLoginWithPhone() {
    OAuthQuickLoginParam quickLoginParam = new OAuthQuickLoginParam.Builder()
            .clientId("28xxxxxxxxx") //小米开放平台中注册应用后可直接获取
            .loginType(2) // 登录方式，1:小米账号一键登录；2:授权登录
            .state("xxxxx") //透传字段 开发者可自定义，字符包含0-9、a-z、A-Z、点号、冒号、斜杠、下划线等，长度限制1-255，校验规则^[0-9a-zA-Z:/\.\-_]{1,255}$
            .nonce("xxxxxxx") //透传字段 开发者可自定义，字符包含0-9、a-z、A-Z、点号、冒号、斜杠、下划线等，长度限制1-255，校验规则^[0-9a-zA-Z:/\.\-_]{1,255}$
            .privacyUrl("https://XXXX.com/XXXXX/") // 隐私政策链接地址，必填
            .privacyText("XXXXX隐私协议") // 隐私政策文案，必填
            .userAgreementUrl("https://XXXX.com/XXXXXX") //用户协议链接地址，必填
            .userAgreementText("XXXX用户协议") //用户协议文案，必填
            .build();
    MiAccount.getInstance().login(this, quickLoginParam, callback);
}

2、错误码

凡泰&快应用客户端接入指南