Overview

What is Stand-alone Xiaomi SDK

Unity SDK for Xiaomi integrates Xiaomi store to Unity IAP, which includes Amazon, Google Play, etc. The stand-alone Xiaomi SDK isn’t integrated to Unity IAP and just include Xiaomi Store SDK.

If developers only need to publish their games to Xiaomi Store, this SDK will suffice.

Process of Using Stand-alone Xiaomi SDK

• Technical Integration
  • Onboarding to Unity, which requires Xiaomi app info (appId, appKey, etc.).
  • Prepare debug file for Xiaomi.
  • Server side integration.
  • Client side integration.
• Build and submit the APKs.

Technical Integration

Onboarding to Unity

Before integration can start, Game developer first needs to onboard to Unity IAP and will obtain the following developer credentials (these keys are binding to the project and bundle id):

• Unity Client Id
• Unity Client Key
• Unity Client Secret
• Unity Client RSA Public Key

Meanwhile, Game needs to provide the appId, appKey and appSecret offered by Xiaomi, and a callback URL of the Game server (if there exists one) to receive order status update.
Before going live, Game developer will also need to whitelist Unity IAP’s production server.
If Game developer works with Unity 5.6.1 or newer version, he can do the onboarding himself with the latest Unity IAP SDK for Xiaomi by following steps:
(Note: The organization owner is allowed to generate/update Unity Client and user/manager can only read exited Unity Client information. Setting the Test Mode is allowed for everyone.)

1. Import stand-alone Xiaomi SDK (https://unitytech.github.io/channel)

2. Open the onbording Inspector: click the AppStoreSettings.asset at UnityChannel/XiaomiSupport/Resources.
   
   If the current Unity Project has owned one project ID (if not, please create one project ID first), the Inspector will show the information for onboarding.
   

3. To generate one Unity Client, Game developer can click Generate Unity Client and get the related Unity Client information. For this step, the callback url and the Xiaomi app information (appId, appKey, appSecret) is not necessary. The callback url and Xiaomi app information can be provided by later updating by clicking Save All Settings. Meanwhile, when switching Test(Debug) Mode for application, Save All Settings is also needed to be clicked to save the choice.

If the current Unity Project has already onboarded, the existed Unity Client will be loaded at this step.

Game developer can use Copy to Clipboard to copy Unity Client Id, Unity Client Key, Unity Client Secret, Unity Client RSA Public Key to clipboard if he wants to store this information by himself. And he can click Update Client Secret to change Unity Client Secret to a new one.

Note:

1. Unity Client Secret (as well as callback url and Xiaomi appSecret) is not used in the application, hence it will not be stored in the asset and built into application, It is only handled in memory.
2. Most operation for onboarding (generating/loading/updating Unity Client) will send networked request to Unity backend server. You can check the log information shown in Console to have an idea of the progress of the operation.

Prepare debug file for Xiaomi

If you want to debug your purchase app, you must have a MiProductCatalog.prop file to tell Xiaomi SDK what products can be used under mode.
Here is an example MiProductCatalog.prop file. The prices must be in line with Xiaomi price tiers.

Server Side Integration

Please see the doc of Unity SDK for Xiaomi.

Client Side Integration

Initialization

Please make sure initialization is called in Awake() or Start().
First, you need to implement ILoginListener:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

private class MyLoginListener : ILoginListener
{
	public void OnLogin(UserInfo userInfo)
    {
        Debug.Log(string.Format("Login Succeed: userId {0}, userLoginToken {1}, channel {2}",
            userInfo.userId, userInfo.userLoginToken, userInfo.channel));
    }
    public void OnInitialized()
    {
        Debug.Log("Initialize Succeed");
    }
    public void OnInitializeFailed(string message)
    {
        Debug.Log("Initialize Failed " + message);
    }
    public void OnLoginFailed(string message)
    {
        Debug.Log("Login Failed: " + message);
    }
}

Then, if you are using App Store Settings(Unity 5.6.1+), you can initialize like this:

1
2
3
4
5
6
7
8
9

using UnityEngine.Store;
......
void Awake()
{
    var myLoginListener = new MyLoginListener();
    AppStoreSettings appStoreSettings = Resources.Load<AppStoreSettings>("AppStoreSettings");
    StoreService.Initialize(appStoreSettings.getAppInfo(), myLoginListener);
}

Otherwise, you can initialize like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

using UnityEngine.Store;
......
void Awake()
{
    var myLoginListener = new MyLoginListener();
    var appInfo = new AppInfo();
    appInfo.appId = "YOUR APP ID";
    appInfo.appKey = "YOUR APP KEY";
    appInfo.clientId = "YOUR CLIENT ID";
    appInfo.clientKey = "YOUR CLIENT KEY";
    appInfo.debug = false; // debug mode or not
    StoreService.Initialize(appInfo, myLoginListener);
}

These info can be obtained when developers have onboarded the app

Login

Login is just a simple statment:

1
2
3
4

using UnityEngine.Store;
......
StoreService.Login(myLoginListener);

Sometimes users can not login using Xiaomi SDK, that maybe because there is no product configured for IAP on Xiaomi portal.

Purchase

First, IPurchaseListener needs to be implemented.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

using UnityEngine.ChannelPurchase;
......
private class MyPurchaseListener : IPurchaseListener
{
    public void OnPurchase(PurchaseInfo purchaseInfo)
    {
        Debug.Log("Purchase Succeed: " + purchaseInfo.gameOrderId);
    }
    public void OnPurchaseFailed(string message, PurchaseInfo purchaseInfo)
    {
        Debug.Log("Purchase Failed: " + message);
    }
    public void OnPurchaseRepeated(string productCode)
    {
        Debug.Log("Purchase Repeated");
    }
    public void OnReceiptValidate(ReceiptInfo receiptInfo)
    {
        Debug.Log("Validate Succeed");
    }
    public void OnReceiptValidateFailed(string gameOrderId, string message)
    {
        Debug.Log("Validate Failed");
    }
    public void OnPurchaseConfirm(string gameOrderId)
    {
        Debug.Log("Confirm Succeed");
    }
    public void OnPurchaseConfirmFailed(string gameOrderId, string message)
    {
        Debug.Log("Confirm Failed");
    }
}

Then call Purchase method.

1
2
3
4

using UnityEngine.ChannelPurchase;
......
PurchaseService.Purchase("Product ID", "Game Order ID", myPurchaseListener);

• Product ID is configured on Xiaomi Dev Portal. If the app is run in debug mode, the Prodcut ID should exist in MiProductCatalog.prop file.
• Game Order ID can be null and our SDK will generate and UUID for it.

Purchase Validation

After one purchase is finished, developers can validate the purchase by calling the ValidateReceipt API:

1
2
3
4

using UnityEngine.ChannelPurchase;
......
PurchaseService.ValidateReceipt(gameOrderId, myPurchaseListener);

if gameOrderId is valid, developers can get a ReceiptInfo in the myPurchaseListener. ReceiptInfo contains signData and signature which can be used to validate the purchase. If the game has a server, this is usually validated on the server, please refer to the server sample code. Developers can also validate the signData on the client side. The procedure can be very similar to the server side validation.

Appendices

Xiaomi Price Tiers

Note that in MiProductCatalog.prop, the unit of price is 1/100 of Chinese Yuan.

API References

Namespace UnityEngine.Store

Class AppInfo

Variables:

Interface ILoginListener

Functions:

class StoreService

Functions:

class UserInfo

Variables:

Namespace UnityEngine.ChannelPurchase

Class PurchaseInfo

Variables:

Class ReceiptInfo

Variables:

Interface IPurchaseListener

Functions:

Class PurchaseService

Functions: