XuqmGroup-AndroidSDK/sdk-license/README.md

Xuqm License SDK

Android SDK for device license registration and verification.

Features

• Stable Device ID: Uses ANDROID_ID (stable per app signing key + device + user), with UUID fallback
• Token Caching: Caches valid status for configurable window (default 10 min) to reduce network calls
• Auto Recovery: Automatically re-registers when token is invalid or revoked
• Offline Support: Returns cached OK status when network is unavailable
• Encrypted License File: Reads assets/xuqm/license.xuqm; the file does not expose appKey or server URL as readable text
• AppKey Change Detection: Automatically clears old data when decrypted appKey changes

Integration

dependencies {
    implementation("com.xuqm:sdk-license:0.1.0-SNAPSHOT")
}

Usage

License File

Download the encrypted License file from the tenant platform and place it at:

app/src/main/assets/xuqm/license.xuqm

The SDK also accepts a tenant-platform downloaded file such as app/src/main/assets/xuqm/MyApp.xuqmlicense.

No explicit initialization code is required.

Check License

LicenseSDK.checkLicense { isValid ->
    if (isValid) {
        // allow app usage
    } else {
        // block app usage or show warning
    }
}

Get Status (no network)

val status = LicenseSDK.getStatus() // OK, DENIED, or UNKNOWN

Re-register (force)

lifecycleScope.launch {
    val result = LicenseSDK.reRegister()
}

Get Device ID

val deviceId = LicenseSDK.getDeviceId()

Configuration

Parameter	Default	Description
appKey	from encrypted file	Company appKey from tenant platform
deviceName	${MANUFACTURER} ${MODEL}	Device display name
baseUrl	https://auto.dev.xuqinmin.com/	License server base URL

Data Storage

All data (device ID, token, status) is stored in EncryptedSharedPreferences with AES-256 encryption.