How to integrate the SDK in your application

-keepclassmembers class kotlinx.** {
    volatile <fields>;
}

How to start the SDK

Starting the SDK should be the first thing that runs in your app. Therefore, you should start it in your Application class:

1. Import the SDK:

import com.perimeterx.mobile_sdk.PerimeterX
import com.perimeterx.mobile_sdk.PerimeterXDelegate
import com.perimeterx.mobile_sdk.main.PXPolicy

import com.perimeterx.mobile_sdk.PerimeterX;
import com.perimeterx.mobile_sdk.PerimeterXDelegate;
import com.perimeterx.mobile_sdk.main.PXPolicy;

2. Make your Application class to implement the PerimeterXDelegate (optional).

class MainApplication: Application(), PerimeterXDelegate

class MainApplication extends Application implements PerimeterXDelegate

3. Create and configure the PXPolicy object, in the Application's onCreate function.

val policy = PXPolicy()
// configure the policy instacne

PXPolicy nativePolicy = new PXPolicy();
// configure the policy instacne

4. It's recommended to tell the SDK which domains it should intercept. Not setting domains will cause the SDK to intercept URL requests from ALL domains, including 3rd party libraries.

policy.setDomains(arrayListOf("my-domain.com"), "<APP_ID>")

ArrayList<String> domains = new ArrayList<>();
domains.add("my-domain.com");
policy.setDomains(domains, "<APP_ID>");

5. Call the PerimeterX/start(application:appId:delegate:policy:) function, with your application, AppID and the policy, in the Application's onCreate function.

try {
    PerimeterX.start(this, "<APP_ID>", this, policy)
}
catch (exception: Exception) {
    println("failed to start. error: ${exception.message}")
}

try {
    PerimeterX.INSTANCE.start(this, "<APP_ID>", this, policy);
}
catch (Exception exception) {  
    Log.e("tag","failed to start. error: " + exception.getMessage());  
}

6. Add the PerimeterX's interceptor (PXInterceptor) to your HttpClient's application interceptors list at the end. This is required for the "Automatic Interception".

OkHttp:

private var okHttpClient: OkHttpClient = OkHttpClient.Builder()  
    .addInterceptor(MyInterceptor())  
    .addInterceptor(PXInterceptor()) // MUST BE THE LAST INTERCEPTOR IN THE CHAIN  
    .build()

private final OkHttpClient httpClient = new OkHttpClient.Builder()  
    .addInterceptor(new MyInterceptor())  
    .addInterceptor(new PXInterceptor()) // MUST BE THE LAST INTERCEPTOR IN THE CHAIN  
    .build();

ktor:

private val httpClient: HttpClient = HttpClient(OkHttp) {  
    engine {  
        addInterceptor(MyInterceptor())  
        addInterceptor(PXInterceptor()) // MUST BE THE LAST INTERCEPTOR IN THE CHAIN  
    }  
}

Adding custom parameters

You may add custom parameters for additional configuration.

try {
   PerimeterX.setCustomParameters(hashMapOf("custom_param1" to "hello", "custom_param2" to "world"))
}
catch (exception: Exception) {
   println("error: ${exception.message}")
}

try {
   PerimeterX.INSTANCE.setCustomParameters(customParameters, null);
}
catch (exception: Exception) {
   Log.e("tag","failed to set custom parameters. error: " + exception.getMessage());
}

Summary

After writing the code above, the SDK will:

1. Intercept your URL requests.
2. Add SDK's HTTP headers to those URL requests.
3. Handle block responses from the server by presenting a challenge to the user.

Next steps

Review the following topics:

• Integration verification and testing
  • How to verify the integration
  • How to test your app with the SDK
• Manual integration
  • Understanding the flow
  • Adding SDK's HTTP headers to your URL requests
  • Handle block responses from your server
• Handle block responses from the server
  • How to retry requests that were blocked
  • Checking the error
  • When will you receive those errors
  • How the SDK presents the block page to the user
• React Native support
  • Integration with React Native
• Hybrid App support
  • What is "Hybrid App"
  • How to enable Hybrid App support
• Account Defender
  • How to enable support for Account Defender
• Multiple AppIDs support
  • Integration with multiple AppIDs
• Migrating from earlier SDK versions
  • From v2 to v3
  • From v1 to v2

Looking for earlier SDK version?

• SDK v2 - How to integrate the SDK in your application
• SDK v1 - How to integrate the SDK in your application