Device Risk SDK iOS Integration

Initialize the SDK

The SDK performs internal initialization and data collection. Make sure the user has agreed to the Fraud Detection SDK Privacy Policy before collecting data. Initialize the SDK as early as possible in your risk scenarios.

• Function prototype

@interface SecurityDevice : NSObject
/**
 * Initialize the device fingerprint SDK.
 */
- (void)initDevice:(NSString *)userAppKey :(void (^)(int))initCallback;

/**
 * Initialize the SDK with options.
 */
- (void)initDevice:(NSString *)userAppKey withOptions:(NSMutableDictionary *)options callback:(void (^)(int))initCallback;

@end

• userAppKey: Identifies the user. This is the product AppKey assigned by Alibaba Cloud (different from an AccessKey). You can obtain it from Device App Management in the Alibaba Cloud console.

• options: Optional data collection parameters. Default: nil. Available options:

• initCallback: Initialization callback listener. You can use the callback to check whether initialization succeeds. Default: nil. For valid values of the code field, see the status codes table.

• Return value: none.

• Example

NSMutableDictionary *options = [[NSMutableDictionary alloc] init];
[options setValue:@"0" forKey:@"IPv6"];       // Set to IPv4
// Set a custom data reporting region
// [options setValue:@"xxx" forKey:@"CustomUrl"];  Set the reporting URL
// [options setValue:@"xxx" forKey:@"CustomHost"]; Set the reporting host

// Standard call (recommended)
[[SecurityDevice sharedInstance] initDevice:@"******" withOptions:options callback:nil];

// Callback call
[[SecurityDevice sharedInstance] initDevice:@"******" withOptions:options callback:^(int code) {
    NSString * initResult = [NSString stringWithFormat: @"Initialization result: %d", code];
    NSLog(@"%@", initResult);

    if (SC_SUCCESS != code) {
        NSLog(@"Initialization failed");
    } else {
        NSLog(@"Initialization successful");
    }
}];

Obtain the client token

Obtain the client token and report it to your business server. The server then calls the Device Risk Detection API to retrieve device risk information.

• Function prototype

@interface SecurityDevice : NSObject
- (SecurityToken *)getDeviceToken;
- (SecurityToken *)getDeviceToken:(NSString *)bizId;
@end

• bizId: The client business ID. Used to associate a business ID with a token. Optional.

• Return value: a SecurityToken object, defined as follows:

@interface SecurityToken : NSObject

/**
 * The session operation result.
 */
@property(atomic) int code;

/**
 * The token result string.
 */
@property(copy, atomic) NSString *token;

@end

• code: The API call status code. Used to determine whether the call succeeded. Valid values:

  FaceSecCode	Code	Description
  SC_SUCCESS	10000	The SDK is initialized.
  SC_NOT_INIT	10001	The SDK is not initialized.
  SC_NOT_PERMISSION	10002	Required permissions are not fully granted.
  SC_UNKNOWN_ERROR	10003	An unknown system error occurred.
  SC_NETWORK_ERROR	10004	A network error occurred.
  SC_NETWORK_ERROR_EMPTY	10005	A network error occurred. The response body is empty.
  SC_NETWORK_ERROR_INVALID	10006	The response format is invalid.
  SC_PARSE_SRV_CFG_ERROR	10007	Failed to parse the server configuration.
  SC_NETWORK_RET_CODE_ERROR	10008	The gateway returned a failure response.
  SC_APPKEY_EMPTY	10009	The AppKey is empty.
  SC_PARAMS_ERROR	10010	A parameter error occurred.
  SC_FGKEY_ERROR	10011	A key calculation error occurred.
  SC_APPKEY_ERROR	10012	The AppKey is invalid.

• token: The token string returned to the client. Used for subsequent queries to the Alibaba Cloud Device Risk Detection API.

• Example

// We recommend passing bizId to prevent deviceToken tampering.
NSString *bizId = @"1234567890abcdef******";
SecurityToken *deviceToken = [[SecurityDevice sharedInstance] getDeviceToken:bizId];

if (deviceToken == nil || SC_SUCCESS != deviceToken.code) {
    NSLog(@"Failed to obtain token. The result cannot be used for risk tag queries.");
} else {
    NSLog(@"Successfully obtained token. You can query risk tags. Token: %@", deviceToken.token);
}

Send the token to your server

After obtaining the deviceToken, send it to your business server for risk result queries and verification.