Fraud Detection:Integrate the Device Fraud Detection SDK for HarmonyOS

1. Initialize (initWithOptions)

This function initializes the SDK and collects device information. Call it as early as possible during app startup while meeting compliance requirements. Call it only once per app launch.

• Function prototype

export class SecurityInitListener {
  // code indicates the API call status code
  onInitFinish(code: number): void {}
}

public initWithOptions(ctx: Context,
                userAppKey: string,
                options: Map<string, string>,
                securityInitListener: SecurityInitListener): void;

• Parameters

  • ctx: The Context of the current Ability.

  • userAppKey: Identifies your application. You can apply for it under Device App Management in the Alibaba Cloud Management Console.

  • securityInitListener: The initialization callback. You can use the callback to check whether initialization succeeds. Default value: null. For valid values of the code field, see Status return values.

  • options: Optional information collection parameters. Default value: null. The available options are as follows.

    Field	Description	Example
    IPv6	Whether to use an IPv6 domain name to report device information. 0 (default): Use an IPv4 domain name. 1: Use an IPv6 domain name.	"0"
    CustomUrl	The domain name of the data reporting server. Used for site-specific reporting. No configuration required by default.	"https://cloudauth-device.aliyuncs.com"
    CustomHost	The host of the data reporting server. Must be used together with CustomUrl. Neither needs to be set by default.	"cloudauth-device.aliyuncs.com"

    CustomUrl and CustomHost parameter description

    For site-specific reporting, set CustomUrl and CustomHost to the designated endpoint for your region. No configuration required by default.

    Region	Address
    Singapore (default)	CustomUrl: https://cloudauth-device.ap-southeast-1.aliyuncs.com CustomHost: cloudauth-device.ap-southeast-1.aliyuncs.com
    China (Hong Kong)	CustomUrl: https://cloudauth-device.cn-hongkong.aliyuncs.com CustomHost: cloudauth-device.cn-hongkong.aliyuncs.com
    Germany	CustomUrl: https://cloudauth-device.eu-central-1.aliyuncs.com CustomHost: cloudauth-device.eu-central-1.aliyuncs.com
    US	CustomUrl: https://cloudauth-device.us-west-1.aliyuncs.com CustomHost: cloudauth-device.us-west-1.aliyuncs.com

• Example

@State USER_PRODUCT_KEY: string = "123e4567e89b12d3a45642661417****";

let options: Map<string, string> = new Map<string, string>();
options.set("IPv6", "0"); // Set to IPv4
// Set a custom data reporting endpoint
// options.set("CustomUrl", "xxx"); Set the reporting site URL
// options.set("CustomHost", "xxx"); Set the reporting site host

SecurityDevice.getInstance().initWithOptions(getContext(),
                            this.USER_PRODUCT_KEY, options, null);

2. Obtain the client token (getDeviceToken)

Obtain the client token and report it to your business server. You can then use the server-side Server-side API integration to retrieve device risk information.

• Function prototype

export class SecurityToken {
   // Result code
  public code:number = 0;

  // deviceToken returned by the SDK
  public token:string = "";
}

// Recommended: pass bizId
public getDeviceToken(bizId?: string): SecurityToken

• Example

// Example with bizId. bizId is the client's business ID; passing it is optional.
let bizId = "1234567890abcdef1234567890ab****";
let tokenObj: SecurityToken = SecurityDevice.getInstance().getDeviceToken(bizId);
if (tokenObj.code == SecurityCode.SC_SUCCESS) {
  console.log("Aliyun Token: " + tokenObj.token);
} else {
  console.log("Aliyun Code: " + tokenObj.code);
}

3. Send the token to your business server

After obtaining the deviceToken, pass it as a parameter to your business server. The server then calls the Alibaba Cloud Device Risk Detection API with the deviceToken to query and verify device risk information.