Mobile Platform as a Service:Connect using the Java SDK

Import the JAR package

After you configure Maven, add the following dependencies to the main pom.xml file:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>mpaas20201028</artifactId>
    <version>5.0.1</version>
</dependency>
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>tea-openapi</artifactId>
    <version>0.3.6</version>
</dependency>

Configure environment variables

Configure the MPAAS_AK_ENV and MPAAS_SK_ENV environment variables.

• For Linux and macOS, run the following commands:

  export MPAAS_AK_ENV=<access_key_id>
  export MPAAS_SK_ENV=<access_key_secret>

  Note

  Replace access_key_id with your AccessKey ID and access_key_secret with your AccessKey secret.

• Windows system configuration

  1. Create the MPAAS_AK_ENV and MPAAS_SK_ENV environment variables. Set their values to your AccessKey ID and AccessKey secret.

  2. Restart Windows.

API reference

Single data synchronization API

The single data synchronization API syncs data to a specific user or device.

Parameter descriptions

The parameters are as follows:

Result codes for single data synchronization

Code example

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.CreateOpenSingleDataRequest;
import com.aliyun.mpaas20201028.models.CreateOpenSingleDataResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // An Alibaba Cloud account AccessKey has full access to all APIs. We recommend that you use a Resource Access Management (RAM) user for API calls and routine O&M.
    // To prevent AccessKey leaks and protect your resources, do not store your AccessKey ID and AccessKey secret in your project code.
    // This example shows how to store the AccessKey ID and AccessKey secret in environment variables. You can also store them in a configuration file as needed.
    Config config = new Config();
    // Required. Your AccessKey ID.
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // Required. Your AccessKey secret.
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // The REGION_ID and Endpoint of mPaaS. This example uses a non-finance region in Hangzhou.
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    CreateOpenSingleDataRequest singleRequest = new CreateOpenSingleDataRequest();
    //*************Required properties*************/
    
    // The App ID obtained from the mPaaS console.
    singleRequest.setAppId("xxxxxxx");
    // The Workspace ID obtained from the mPaaS console.
    singleRequest.setWorkspaceId("xxxxxxxx");
    // The synchronization identity configured in Mobile Sync in the mPaaS console.
    singleRequest.setBizType("TEST-SYNC");
    // The ID of the user or device (UTDID) to push to.
    singleRequest.setLinkToken("testUserId");
    // The actual business message body. The custom length cannot exceed 4,096 characters.
    singleRequest.setPayload("testPayload");
    // The business ID. It must be unique and cannot exceed 100 characters in length.
    singleRequest.setThirdMsgId("test_third_msg_id_" + System.currentTimeMillis());

    //************Optional properties*************/
    
    // The OS of the target device. Valid values: iOS and Android. If left empty, the OS is not restricted.
    singleRequest.setOsType("IOS");
    // The minimum client version number, such as 8.6.0.0.9999. If left empty, the minimum version is not restricted.
    singleRequest.setAppMinVersion("0.0.0.0");
    // The maximum client version number, such as 9.0.0.0.9999. If left empty, the maximum version is not restricted.
    singleRequest.setAppMaxVersion("100.100.100.100");
    // The start of the validity period. If left empty, the start time is not restricted.
    singleRequest.setValidTimeStart(System.currentTimeMillis());
    // The end of the validity period. If left empty, the end time is not restricted. The maximum validity period is 30 days.
    singleRequest.setValidTimeEnd(System.currentTimeMillis() + (1000 * 3600));

    CreateOpenSingleDataResponse openSingleData = client.createOpenSingleData(singleRequest);
    System.out.println("response==>"+JSON.toJSONString(openSingleData));
}

Global data synchronization API

Global data synchronization synchronizes data to all devices.

Parameter descriptions

The following are the business parameters:

Result codes for global data synchronization

Code example

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.CreateOpenGlobalDataRequest;
import com.aliyun.mpaas20201028.models.CreateOpenGlobalDataResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // An Alibaba Cloud account AccessKey has full access to all APIs. We recommend that you use a Resource Access Management (RAM) user for API calls and routine O&M.
    // To prevent AccessKey leaks and protect your resources, do not store your AccessKey ID and AccessKey secret in your project code.
    // This example shows how to store the AccessKey ID and AccessKey secret in environment variables. You can also store them in a configuration file as needed.
    Config config = new Config();
    // Required. Your AccessKey ID.
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // Required. Your AccessKey secret.
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // The REGION_ID and Endpoint of mPaaS. This example uses a non-finance region in Hangzhou.
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    CreateOpenGlobalDataRequest globalRequest = new CreateOpenGlobalDataRequest();
    //*************Required properties*************/

    // The App ID obtained from the mPaaS console.
    globalRequest.setAppId("BE9C457161429");
    // The Workspace ID obtained from the mPaaS console.
    globalRequest.setWorkspaceId("sit");
    // The synchronization identity configured in Mobile Sync in the mPaaS console.
    globalRequest.setBizType("test-global");
    // The actual business message body. The custom length cannot exceed 4,096 characters.
    globalRequest.setPayload("testtestata");
    // The business ID. It must be unique and cannot exceed 100 characters in length.
    globalRequest.setThirdMsgId("test_third_msg_id_" + System.currentTimeMillis());

    //************Optional properties*************/

    // The OS of the target device. Valid values: iOS and Android. If left empty, the OS is not restricted.
    globalRequest.setOsType("IOS");
    // The minimum client version number, such as 8.6.0.0.9999. If left empty, the minimum version is not restricted.
    globalRequest.setAppMinVersion("0.0.0.0");
    // The maximum client version number, such as 9.0.0.0.9999. If left empty, the maximum version is not restricted.

    globalRequest.setAppMaxVersion("100.100.100.100");
    // The maximum UID.
    globalRequest.setMaxUid(Long.valueOf(99));
    // The minimum UID.
    globalRequest.setMinUid(Long.valueOf(1));
    // The grayscale UIDs to push to, from 00 to 99. This is a string array.
    globalRequest.setUids("01,02,99");

    globalRequest.setValidTimeStart(System.currentTimeMillis());
    globalRequest.setValidTimeEnd(System.currentTimeMillis() + (1000 * 3600));
    CreateOpenGlobalDataResponse openGlobalData = client.createOpenGlobalData(globalRequest);
    System.out.println("response==>"+JSON.toJSONString(openGlobalData));
}