Device Risk Identification API Integration Guide

Select an edition

• Basic Edition: Suitable for scenarios that require only risk tag determination, such as basic risk control requirements like identifying whether a device is an emulator, rooted, or running in a multi-instance environment.

• Enhanced Edition: Suitable for scenarios that require a unique device ID for cross-session tracking, or require log delivery to Log Service (SLS) for in-depth analysis.

Service Parameter

The Service parameter specifies the service edition to call. The following table lists the Service parameter values for different editions.

ServiceParameters

ServiceParameters contains the specific business request parameters in JSON format, corresponding to the ServiceParameters field in Common Parameters. The following table describes the request parameters for the device risk identification service (including Basic Edition and Enhanced Edition).

Device ID

See the extend field in the response parameter Data. The unique device ID is returned only in the Enhanced Edition.

Device risk tags

See the tags field in the response parameter Data. If multiple tags are returned, they are separated by commas. Some tag meanings are as follows:

For more information, see Common Parameters.

Error codes

Maven dependencies

Java Maven dependency:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-saf</artifactId>
    <version>3.0.1</version>
</dependency>

Recommended Java Maven dependency versions:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <optional>true</optional>
    <version>4.5.25</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.68.noneautotype</version>
</dependency>
<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.3</version>
</dependency>
<dependency>
    <groupId>io.opentracing</groupId>
    <artifactId>opentracing-util</artifactId>
    <version>0.31.0</version>
</dependency>

Java SDK source code

// The AccessKey pair of an Alibaba Cloud account has permissions on all API operations.
// We recommend that you use a RAM user for API access and daily O&M.
// Do not save the AccessKey ID and AccessKey Secret in your project code to prevent AccessKey leakage,
// which may compromise the security of all resources under your account.
// This example uses environment variables to read the RAM user AccessKey for API authentication.
// Before running this code, make sure the following environment variables are configured:
// ALIBABA_CLOUD_ACCESS_KEY_ID, ALIBABA_CLOUD_ACCESS_KEY_SECRET.
// Create and initialize a DefaultAcsClient instance. Initialize only once.
DefaultProfile profile = DefaultProfile.getProfile(
    "cn-shanghai", // Region ID. cn-shanghai is recommended for the China site. Must match the client SDK reporting domain.
    System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),     // RAM user AccessKey ID
    System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")  // RAM user AccessKey Secret
);
// HTTP connection pool configuration
HttpClientConfig clientConfig = HttpClientConfig.getDefault();
clientConfig.setMaxRequestsPerHost(6);
clientConfig.setMaxIdleConnections(20);
// HTTP timeout configuration
clientConfig.setReadTimeoutMillis(10000);
clientConfig.setConnectionTimeoutMillis(3000);
profile.setHttpClientConfig(clientConfig);
IAcsClient client = new DefaultAcsClient(profile);

// Send the request
ExecuteRequestRequest executeRequestRequest = new ExecuteRequestRequest();
// To specify a custom version number, modify it here. Default: 2019-05-21
executeRequestRequest.setVersion("2019-05-21");
// Specify the request method
executeRequestRequest.setSysMethod(MethodType.POST);
// Specify the protocol. Currently, only HTTPS is supported.
executeRequestRequest.setSysProtocol(ProtocolType.HTTPS);

// Product code for the device risk identification service: device_risk or device_risk_pro.
// See the Service parameter row in the "Editions" table.
String service = "device_risk";
executeRequestRequest.setService(service);
// Business parameters. Set only the parameters you need.
Map<String, Object> serviceParams = new HashMap<String, Object>();
// deviceToken is required.
serviceParams.put("deviceToken", "TK******************");
executeRequestRequest.setServiceParameters(JSONObject.toJSONString(serviceParams));
executeRequestRequest.setAcceptFormat(FormatType.JSON);

try {
    ExecuteRequestResponse httpResponse = client.getAcsResponse(executeRequestRequest);
    System.out.println("httpResponse:" + JSONObject.toJSONString(httpResponse));
} catch (Exception e) {
    e.printStackTrace();
}

Verify the call result

After calling the SDK to send a request, you can verify the integration by checking the following:

• A return value of Code=200 indicates that the request is successful.

• The returned Data object contains the tags field, which indicates that the device risk detection result is returned as expected.