一、基础版SDK方式

1.1 集成SDK

1.1.1 添加AAR

添加小米安全开放服务SDK到项目Module（app）的libs路径中

SDK文件

名称:sdk-xsof-20251027-v3.0.0-basic-release.aar

地址:https://kpan.mioffice.cn/webfolder/ext/DoRhkFel%231v%24uVm31GQvyw%40%40

密码:SC8D

1.1.2 配置Gradle

在Module所属的Gradle文件（app/build.gradle）中增加编译依赖

// 只添加libs/sdk-xsof-20251027-v3.0.0-basic-release.aar一个aar
implementation files('libs/sdk-xsof-20251027-v3.0.0-basic-release.aar')

或

// 添加libs文件夹下的所有aar
implementation fileTree(dir: "libs", includes: "*.aar")

注意：上述步骤中的文件路径和Gradle配置仅供参考，
可根据项目实际情况灵活调整，只要保证aar参与到项目编译即可。

1.1.3 配置appId、appKey

在项目中添加应用的appId、appKey等信息
应用在小米开放平台注册后，会分配对应的appId和appKey。
appId和appKey在SDK初始化时会用到，需要调用方提供。
appId和appKey可以在代码中写常量，也可以在工程中增加配置文件，然后在SDK初始化时读取。

注意：正式接入时，会提供配置后台给三方开发者来开启服务&上传SHA256证书指纹。

SHA256证书指纹查询方法：
1. 通过终端keytool命令查询

keytool -list -v -keystore <keystore-file-path>

2. 通过Android Studio Gradle的signingReport task查询

1.2 API使用说明

完成步骤1后，即可使用小米安全开放框架SDK提供的API。

1.2.1 API简要说明

public class MiSafetyDetectClient {

    /**
     * 初始化SDK
     * @param appId   应用的AppId
     * @param appKey  应用的AppKey
     */
    public void init(String appId, String appKey);
    
    /**
     * 获取设备可信检测信息
     * @param challenge  随机数
     * @param onCompleteListener 接收检测结果的回调
     */
    public void getTrustDeviceStatus(String challenge, 
        OnCompleteListener<TrustDeviceStatusResponse> onCompleteListener);

    /**
     * 获取恶意应用检测信息
     * @param onCompleteListener 接收检测结果的回调
     */
    public void getRiskApps(
        OnCompleteListener<RiskAppResponse> onCompleteListener);
    
    /**
     * 获取模拟点击检测信息
     * @param timeInterval 需要检测的时间范围
     * @param onCompleteListener 接收检测结果的回调
     */
    public void getSimulatedTouchDetectResult(long timeInterval, 
        OnCompleteListener<SimulatedTouchResponse> onCompleteListener);
           
    /**
     * 获取欺诈风险评分
     * @param challenge 随机数
     * @param callback 接收检测结果的回调
     */
    public void getFraudRiskScore(String challenge, OnCompleteListener<FraudScoreResponse> onCompleteListener);
    
}

1.2.2 使用示例

1. SDK初始化

import com.xiaomi.security.xsof.MiSafetyDetect;
import com.xiaomi.security.xsof.safetydetect.MiSafetyDetectClient;

ClassName {
    private static final String APP_ID = "***"; // replace with your appId
    private static final String APP_KEY = "***"; // replace with your appKey

    // 通过MiSafetyDetect#getMiSafetyDetectClient获取MiSafetyDetectClient实例
    MiSafetyDetectClient miSafetyDetectClient = 
        MiSafetyDetect.getMiSafetyDetectClient(getContext());
    // 如果是null，说明当前系统版本不支持安全开发框架相关服务
    if (miSafetyDetectClient != null) {
        miSafetyDetectClient.init(APP_ID, APP_KEY);
    }
}

初始化后即可使用小米安全开放框架提供的各项服务。

目前小米安全开放框架已支持三项检测：

1. 设备可信检测
2. 恶意应用检测
3. 模拟点击检测

详细信息请参考开发者文档

2. 判断当前设备是否支持涉诈行为检测

/**
 * 判断是否支持欺诈检测
 * @return boolean
 */
private fun isSupportFraudDetection(): Boolean {
    return miSafetyDetectClient != null && getSafetyDetectServerVersion(this) >= 3
}

/**
 * 获取安全开放服务版本。安全开放服务在3及以上版本才支持欺诈检测
 * @param context Context
 * @return int
 */
private fun getSafetyDetectServerVersion(context: Context): Int {
    try {
        val packageManager = context.packageManager
        val packageInfo = packageManager
            .getPackageInfo(
                "com.miui.securitycenter",
                PackageManager.GET_META_DATA
            )
        val metaData = packageInfo.applicationInfo?.metaData
        if (metaData?.containsKey("com.xiaomi.security.xsof.service.version") == true) {
            return metaData.getInt("com.xiaomi.security.xsof.service.version")
        }
    } catch (e: Exception) {
        // empty
    }
    return 0
}

3. 获取诈骗风险评分

/**
 * 获取诈骗风险评分
 */
private fun getFraudScoreDetectionResult() {
    if (!isSupportFraudDetection()) {
        return
    }
    val challenge: String = SdkUtils.Companion.getChallengeFromServer(packageName)
    miSafetyDetectClient?.getFraudRiskScore(challenge, OnCompleteListener { response: MiSafetyDetectApi.FraudScoreResponse? ->
        if (response?.isSuccess == true) {
            Log.i(TAG, "fraud score detection result : " + response.detectionResult)
            val resp = response.detectionResult
            try {
                val jsonObject = JSONObject(resp)
                val data: String? = jsonObject.get("data").toString()
                val authenticity = jsonObject.get("authenticity") as JSONObject
                val checkResult = "check hash: " + HashUtils.checkHashSHA256(data, authenticity)
                Log.i(TAG, checkResult)
            } catch (e: JSONException) {
                Log.e(TAG, "onComplete: ", e)
            }
        } else {
            val statusCode = response?.statusCode
            Log.e(TAG, "Get fraud score detection result error, code = $statusCode")
        }
    })

二、进阶版SDK方式

服务是免费的，但此服务只提供给愿意与小米深度合作的伙伴。
请使用企业邮箱联系developer@xiaomi.com，与我们建立联系后，获取进阶版SDK与AIDL接入方式。

集成方式同基础版SDK，区别是额外提供了3个涉诈元数据检测api。

• 获取当前欺诈风险结果
• 获取前序欺诈风险结果
• 获取涉诈行为持续时长

三、开放服务错误码