Things to keep handy before starting your integration with Apxor
Please have the following handy before beginning the integration:
Application identifier generated on the Apxor dashboard for your app
()
App Bundle Id : Every app has a unique application ID that looks like com.example.myapp. This id uniquely identifies the app on the device and also on the app store.
The list of events to setup triggers and track goals, user properties that allows to personalize messages and to target better.
()
Cordova Integration
Step 1: Getting started
Run the following command in your terminal from the project folder. This command will fetch the apxor plugins for you.
cordova plugin add cordova-plugin-apxor-sdk
Step 2: Handle deeplink redirection
Use registerDeeplinkHandler to listen on deeplink redirection from Apxor SDK and handle redirection logic (including external redirection) within application logic as follows
ApxorSDK.registerDeeplinkHandler((deeplinkUrl) => {
// Whenever redirection happens from InApp notification buttons,
// this callback will be executed.
switch (deeplinkUrl) {
case "scheme://about":
// Redirect to About Component
break;
default:
// Check if it's external URL and redirect to Browser
break;
// and so on
}
});
Android Integration
Step 1: Add dependencies
Add plugin dependencies to your application build.gradle file
Path: <project>/<app-module>/build.gradle:
1.1 ApxorSDK dependencies (mandatory)
dependencies {
//...
// Event tracking and a must-have dependency for other plugins
implementation 'com.apxor.androidx:apxor-android-sdk-core:3.1.9@aar'
// Add these for Realtime Actions and Surveys
implementation 'com.apxor.androidx:apxor-android-sdk-qe:1.8.5@aar'
implementation 'com.apxor.androidx:apxor-android-sdk-rtm:2.6.4@aar'
implementation 'com.apxor.androidx:surveys:2.2.7@aar'
// Helper plugin to create walkthroughs
implementation 'com.apxor.androidx:wysiwyg:1.6.3@aar'
// Add the below two dependencies to establish an SSE connection for WYSIWYG
implementation 'com.squareup.okhttp3:okhttp:4.9.0'
implementation 'com.launchdarkly:okhttp-eventsource:2.5.0'
//...
}
1.2 Add exoplayer in your app (optional)
Add exoplayer in your app
Exoplayer enables you to configure Picture In Picture videos from the Apxor dashboard; if you are already using the exoplayer in your app, this step is not needed; otherwise, add the following dependency in the application build.gradle file. To use video pip templates, this is necessary.
For com.apxor.androidx:apxor-android-sdk-rtm:2.3.6@aar version onwards
If you use proguard to obfuscate the classes, you have to add the following to ignore obfuscation for Apxor SDK classes
Configure the below rules in your proguard-rules.pro file
Path: <project>/<app-module>/gradle.properties:
-keep class com.apxor.** { *; }
-dontwarn com.apxor.**
Note:
If you use androidx libraries, add the following property in gradle.properties file
android.enableJetifier = true
Step 2: Initialize Apxor Android SDK
To Auto initialize SDK (Recommended), add following meta-data tag inside your application tag in your AndroidManifest.xml file
<application>
<!-- You must replace your app in android:value attribute -->
<meta-data android:name="APXOR_APP_ID" android:value="APP_ID" />
</application>
To manually initialize SDK, call ApxorSDK.initialize method in your Application class
//...
import com.apxor.androidsdk.core.ApxorSDK;
public class MyApplication extends Application {
@Override
public void onCreate() {
// ...
ApxorSDK.initialize(<YOUR_APP_ID>, this.getApplicationContext());
}
}
Step 3: Enable uninstall tracking for your users [Optional]
Note
If you would like to track uninstalls, you must include apxor-android-sdk-push dependency in app/build.gradle file and corresponding JSON object in assets/plugins.json file
Apxor sends silent push notifications to track uninstalls. Please make sure you handle push notifications which will be sent with your SENDER_ID and ignore all notifications other than your SENDER_ID
Apxor uses your firebase server key to send silent push notifications to track uninstalls in order to measure outcomes of your campaign. To enable this please do the following :
Path : app/build.gradle
firebase-messaging version >= 22.0.0
Add the following dependency in your app/build.gradle
dependencies {
// Add this to track uninstalls and send push notifications from Apxor dashboard
implementation('com.apxor.androidx:apxor-android-sdk-push-v2:1.2.7@aar') {
exclude group: 'com.google.firebase'
}
}
Add the following dependency in your app/build.gradle
dependencies {
// Add this to track uninstalls and send push notifications from Apxor dashboard
implementation('com.apxor.androidx:apxor-android-sdk-push:1.2.7@aar') {
exclude group: 'com.google.firebase'
}
}
If you are not using FirebaseMessagingService, you can skip this step. Otherwise, add the following
public class MyFirebaseMessagingService extends FirebaseMessagingService {
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
// Creating Notification Channel
ApxorPushAPI.createNotificationChannel(this.getApplicationContext(), "Apxor", "Apxor", "Apxor");
if (remoteMessage.getFrom().equals(YOUR_FCM_SENDER_ID)) {
// Push Notification receiver with your Sender Id
} else {
// Check if Push Notification received from Apxor
if (ApxorPushAPI.isApxorNotification(remoteMessage)) {
ApxorPushAPI.handleNotification(remoteMessage, getApplicationContext());
} else {
// Silent or Data push notification which you can send through Apxor dashboard
}
}
}
}
To anchor a tooltip or coachmark or badge to any UI element, this step is mandatory.
If you will only use In-app messages, this step can be skipped.
In your MainActivityonCreate method you must set the tag for the WebView as follows to view the tooltips.
public class MainActivity extends CordovaActivity
{
@Override
public void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
// Your logic goes here
appView.getView().setTag("MyWebView");
}
}
Step 5: Ensuring ApxorSDK is initialised successfully
We have to verify for two things as follows :
SDK Initialisation
On running your android project lookout for the following log in logcat :
By default, only error logs are enabled. To see debug logs for plugin initialisation and to confirm tracking event triggers, user properties. Please run the below command in terminal
adb shell setprop log.tag.Apxor VERBOSE
Note
Apxor uploads data only when the app is minimized to the background. If you are running from Android Studio (emulators or devices), do not stop the app, just press on the "home" button in order for data to be uploaded.
Step 6: Log data to set up triggers and measure goals
Now as we are done with basic integration, we can go ahead to setup event triggers, capture data for targeting and to personalize messaging.
iOS integration
Initialize Apxor iOS SDK
To Auto initialize SDK, add the following inside your application plist file.
Open your application's Info.plist as source code.
Copy paste the below piece of code, to create an entry for ApxorSDK.
First, you need to configure your app to ensure there is a URL Scheme with your application's bundle identifier as the value.
If your app already has a URL Scheme with your application's bundle identifier as the value, you can skip this step.
Configuring URL Scheme
To configure URL scheme, goto your project settings, select Targets. Click on the Info tab.
Select the URL Types, and click on the + button to add a new URL Scheme.
Add a new URL Scheme with your bundle identifier as the value.
Your bundle identifer will be in the format, com.xxxx.xxxx
Use the image below for reference.
Note
Make sure the URL scheme has the value of your bundle identifier that was provided in the dashboard while registering with us. Also, the app must have same bundle identifier.
Handling the deep link
Using AppDelegate
You'd need to enable Apxor to handle Apxor specific deeplinks.
In your application's AppDelegate file, in the function application(_:open:options:), add the following code at the beginning,
// Swift
/*
Apxor's code to handle deeplinks
*/
let urlStr = url.absoluteString
if (urlStr.contains("add-test-device")) {
ApxorSDK.handleDeeplink(url)
}
This will ensure the Apxor specific deep links are handle by our SDK.
Using SceneDelegate
You'd need to enable Apxor to handle Apxor specific deeplinks.
In your application's SceneDelegate file, add the following code at the beginning,
// Swift
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
let url = URLContexts.first?.url
let urlStr = url?.absoluteString
if (urlStr!.contains("add-test-device")) {
ApxorSDK.handleDeeplink(url!)
}
}
To show tooltips
In your MainViewController (the ViewController extending the CDVViewController) init method you must set the tag for the WebView as follows to view the tooltips.
// ...
if (self.webView != null) {
[self.webView setTag:123];
NSLog(@"My webview is: %@", self.webView);
} else {
NSLog(@"Error in setting TAG to webview");
}
// ...
Note
Ensure your webview isn't null and the TAG is set correctly.
You have to init the APXWKScriptHandler and call registerEventsAndScripts method to make sure any the calls made in the webview are taken care by the native SDK. It's as follows,
Add the following in the bridging header file.
#import "APXRTAPlugin/APXWKScriptHandler.h"
Now, add the following to the init method of your webview
let apxHandler: APXWKScriptHandler = APXWKScriptHandler.init(handlerFor: webView)
apxHandler.registerEventsAndScripts()
Here's how to do the same thing in objective-C.
Make sure there's a proper WKUserContentController set to your WkWebView, if not please init it and use that config to initialise your WKWebView.
Apxor uploads data only when the app is minimized to the background. If you are running from XCode (emulators or devices), do not stop the app, just press on the "home" button in order for data to be uploaded.
Additional features API Guide
Click here to and
on how to get your firebase sender ID and also FCM server key to share it with apxor to configure uninstall tracking.
to log user properties, events and event properties.
If you don't already have a bridging header,
to log user properties, events and event properties.
