# DeviceConnect: Ionic Capacitor

The DeviceConnect Ionic Capacitor SDK enables the collection of anonymized, non-PII data from user devices, ensuring compliance with privacy policies by obtaining explicit user consent before initiating data sync processes.

# Requirements

Device Connect SDK works on Android 5.0+ (API level 21+), requires Java 8+, and uses AndroidX libraries. To ensure compatibility with Android 7.0 and below, enable desugaring in the project build settings.

Kotlin
Groovy

android {
    ...
    defaultConfig {
        ...
        // Minimum 5.0+ devices
        minSdk 21
        ...
    }
    ...
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled = true
        // Sets Java compatibility to Java 8
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    // For Kotlin projects
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

dependencies {
    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:1.1.5")
}

# Add Plugin

Specify the following keys in local.properties file:

ACCESS_KEY=<ACCESS_KEY>
SECRET_KEY=<SECRET_KEY>
DC_SDK_VERSION=<DC_SDK_VERSION>
COMMON_SDK_VERSION=<COMMON_SDK_VERSION>
COMMON_FLAVOR=<COMMON_FLAVOR>
LOGGER_SDK_VERSION=<LOGGER_SDK_VERSION>

In the project level build.gradle file, add the repository urls to all allprojects block.

Kotlin
Groovy

maven {
    setUrl("s3://risk-manager-android-sdk/artifacts")
    credentials(AwsCredentials::class) {
        accessKey = <ACCESS_KEY>
        secretKey = <SECRET_KEY>
    }
    content {
        includeGroup("in.finbox")
    }
}

Add plugin dependency

NPM
Yarn

npm install --save ionic-risk-sdk

NOTE

Following will be shared by FinBox team at the time of integration:

ACCESS_KEY
SECRET_KEY
DC_SDK_VERSION
COMMON_SDK_VERSION
COMMON_FLAVOR
LOGGER_SDK_VERSION
CLIENT_API_KEY

# Create User

To create a user, call the createUser method with the following arguments:

Client API Key
Customer ID

IMPORTANT

CUSTOMER_ID Must be alphanumeric (no special characters).
Should not exceed 64 characters.
Must not be null or an empty string "".

The response to this method (success or failure) can be captured using the callback.

import { IonicRiskSdk } from 'ionic-risk-sdk';
//Function to trigger RiskSdk
const token = await IonicRiskSdk.createUser({ apiKey: API_KEY, customerId: CUSTOMER_ID });

You can read about the errors in the Error Codes section.

# Start Periodic Sync

The startPeriodicSync method should be invoked only after receiving a successful response from the createUser method callback. This method initiates background syncing for all data sources based on the permissions granted by the user. Data is synced at regular intervals in the background, ensuring continuous and seamless data collection.

IonicRiskSdk.startPeriodicSync(); //Start the sync periodically after every 12 hour

RECOMMENDATION

To handle cross-login scenarios:

When a user logs back into the app with fresh credentials:

Call the createUser method to register the new user.
Follow it by startPeriodicSync to resume data syncing for the new user. Even though the SDK automatically adapts to a new user, this approach minimizes potential delays in syncing during the first session

# Match Details on Device

Device matching enables additional pattern recognition to match email, phone numbers and name. The matching happens on the device and the user phone numbers, email addresses won't leave the device.

To set up device matching in your Ionic Capacitor project, use the following method with the customer's email address, phone number, and name:

IonicRiskSdk.setDeviceMatch("useremail@gmail.com", "Full Name", "9999999999");

# Forward Notifications to SDK

Certain phone manufacturers, implement aggressive battery optimization features that kill apps running in the background after a certain period of inactivity. This can prevent the DeviceConnect SDK's continuous syncing from functioning properly, as it relies on background data collection. In such cases, FinBox’s server may need to request data from the SDK when continuous sync has stopped.

To enable this functionality, we use Firebase Cloud Messaging (FCM) notifications process. Forwarding these notifications allows the app to "wake up" if it has been killed by the device’s background processes, ensuring continuous data collection. When the app receives an FCM notification, it "wakes up" and continues collecting the necessary data for integration.

Configure Firebase Cloud Messaging (FCM) in your Ionic Capacitor project and implement a notification handler to forward received notifications to the DeviceConnect SDK.

Here’s an example of how to forward FCM notifications:

IonicRiskSdk.forwardFinBoxNotificationToSDK(event.data);

# Cancel Periodic

Make sure to cancel data synchronization tasks when the user logs out of the app by using the stopPeriodicSync method. This ensures that no background sync operations continue unnecessarily, maintaining data security.

IonicRiskSdk.stopPeriodicSync();

# Handle Sync Frequency

By default, the sync frequency is set to 8 hours. You can customize this frequency by calling the setSyncFrequency method and passing your preferred interval in seconds as an argument. Ensure this method is invoked after the user is created

# Reset User Data

If you need to clear a user's data stored on the device and initiate a fresh data sync, use the resetData method. This ensures that all previous data is removed, and syncing starts from scratch.

IonicRiskSdk.resetData();

# Forget User

If a user requests to be forgotten, use the forgetUser method. This will delete all user details from our system, ensuring this meets digital guidelines for right to be forgotten.

IonicRiskSdk.forgetUser();

RECOMMENDATION

When a user logs out, call both stopPeriodicSync and resetData to:
- Stop any ongoing periodic sync processes.
- Clear existing user data. This approach ensures a clean state before the next user session.

← Cordova SDK setup Error Codes →