Getting Started
Get started with ContextSDK — sign up, create a license key, and integrate the SDK with step-by-step setup guides for all platforms.
Sign Up and Create a License Key
To start using ContextSDK, sign up in our ContextSDK Dashboard and create a license key for your app. This key is required to authenticate your integration with ContextDecision or ContextPush.
SDK Integration
Once you have your license key, integrate ContextSDK into your app. The following sections provide step-by-step instructions for iOS, Android, Flutter, Unity, and React Native.
Installation
Add https://github.com/context-sdk/context-sdk-releases.git as a dependency in Xcode Package Dependencies or in your Package.swift file:
dependencies: [
.package(url: "https://github.com/context-sdk/context-sdk-releases", .upToNextMajor(from: "5.12.0")),
]Add the following dependency to your Podfile and run pod install :
pod "ContextSDK"Download the latest version of ContextSDK: ContextSDK.zip
In Xcode, drag
ContextSDK.xcframeworkinto the Project Navigator.Open your project settings, navigate to
Frameworks, Libraries, and Embedded Content, addContextSDK.xcframework, and set it toEmbed & Sign.
To download a specific version, replace latest in the download URL with the desired version number. For example, to download version 5.12.0:
https://storage.googleapis.com/de73e410-context-sdk-releases/5.12.0/ContextSDK.zip
SDK Initialization
import ContextSDK
class AppDelegate: NSObject, UIApplicationDelegate {
// …
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
// …
ContextManager.applicationDidFinishLaunchingWithOptions(launchOptions, licenseKey: "YOUR_LICENSE_KEY")
// …
}
}Create an
AppDelegateclass if you don't have one yet:
import ContextSDK
class AppDelegate: NSObject, UIApplicationDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
ContextManager.applicationDidFinishLaunchingWithOptions(launchOptions, licenseKey: "YOUR_LICENSE_KEY")
return true
}
}If you didn't have an
AppDelegateclass yet, add aUIApplicationDelegateAdaptorproperty wrapper to yourAppscene:
struct YourApp: App {
@UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
// …
}Installation
Note: Android support is currently in beta. To obtain a license key, contact us at [email protected]
Add the ContextSDK Maven repository in your project-level settings.gradle.kts:
dependencyResolutionManagement {
repositories {
// …
// Add the ContextSDK Maven repo:
maven {
url = uri("https://storage.googleapis.com/fc4073e9-contextsdk-maven/")
}
}
}Add the ContextSDK dependency in your module-level build.gradle.kts:
dependencies {
// …
implementation("com.contextsdk:contextsdk:1.0.0")
}Add the ContextSDK Maven repository in your project-level settings.gradle:
dependencyResolutionManagement {
repositories {
// …
// Add the ContextSDK maven repo:
maven {
url 'https://storage.googleapis.com/fc4073e9-contextsdk-maven/'
}
}
}Add the ContextSDK dependency in your module-level build.gradle:
dependencies {
// …
implementation 'com.contextsdk:contextsdk:1.0.0'
}SDK Initialization
In your Application subclass, initialize ContextSDK by calling setup with your license key:
class MainApplication : Application() {
override fun onCreate() {
super.onCreate()
ContextSDK.setup(this, "YOUR_LICENSE_KEY")
}
}In your primary Activity subclass, or in every Activity in your application, allow ContextSDK to attach and detach:
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
ContextSDK.attachToActivity(this)
}
override fun onDestroy() {
super.onDestroy()
ContextSDK.detachFromActivity(this)
}
}In your Application subclass, initialize ContextSDK by calling setup with your license key:
public class MainApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
ContextSDK.Companion.setup(this, "YOUR_LICENSE_KEY", new ContextSDKConfiguration());
}
}In your primary
Activitysubclass, or in everyActivityin your application, allow ContextSDK to attach and detach:
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ContextSDK.Companion.attachToActivity(this);
}
@Override
protected void onDestroy() {
super.onDestroy();
ContextSDK.Companion.detachFromActivity(this);
}
}The Activity must conform to LifecycleOwner, such as AppCompatActivity. Standard Activity subclasses are not supported.
If ContextSDK is not set up correctly, it will be unable to start or stop collecting accelerometer and gyroscope data.
Installation
Add context_sdk to your pubspec.yaml:
dependencies:
context_sdk: ^latest_versionEnsure your project meets the Minimum SDK Requirements target by updating your ios/Podfile, e.g.:
platform :ios, "14.0"SDK Initialization
Add the following code to your app’s launch:
import 'package:context_sdk/context_sdk.dart';
final _contextSdkPlugin = ContextSdk();
_contextSdkPlugin.setup("YOUR_LICENSE_KEY");Installation
Download the latest version of ContextSDK: ContextSDK.zip.
In your Unity project, drag
ContextSDK.xcframeworkinto theAssets/Plugins/iOSfolder.Add the
ContextSDKBinding.csscript in the same folder.
To download a specific version, replace latest in the download URL with the desired version number. For example, to download version 5.12.0:
https://storage.googleapis.com/de73e410-context-sdk-releases/5.12.0/ContextSDK.zip
SDK Initialization
Set up the ContextManager in the Start() method of a MonoBehaviour that runs early in your game, before accessing the SDK:
using static ContextSDKBinding;
public class InitContextSDK : MonoBehaviour
{
void Start()
{
ContextSDKBinding.SetupWithAPIBackend("YOUR_LICENSE_KEY");
}
}Installation
Install ContextSDK using your preferred package manager:
npm install react-native-context-sdk@latestor
yarn add react-native-context-sdkEnsure your project meets the Minimum SDK Requirements target by updating your ios/Podfile, e.g.:
platform :ios, "14.0"SDK Initialization
Add the following code to your app’s launch:
import { setup } from "react-native-context-sdk";
void setup("YOUR_LICENSE_KEY");ContextDecision
ContextDecision optimizes conversion funnels by intelligently determining the best moments to present monetization or engagement opportunities. Now that you’ve integrated ContextSDK, to get started with ContextDecision, see Logging Conversions.
ContextPush
ContextPush improves the timing of non-transactional push notifications by leveraging user's real-life context. To begin integrating ContextPush, see Integrating ContextPush.
Last updated
Was this helpful?