> For the complete documentation index, see [llms.txt](https://docs.contextsdk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.contextsdk.com/basics/getting-started.md).

# 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](https://dashboard.contextsdk.com/) and create a license key for your app. This key is required to authenticate your integration with ContextDecision or ContextPush.

{% hint style="info" %}
If your app has a different bundle ID or package name for different environments, register each one of them separately, as each environment will have a unique license key that should be used.
{% endhint %}

## 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.

{% tabs %}
{% tab title="iOS" %}
**Installation**

{% tabs %}
{% tab title="Swift Package Manager (SPM)" %}
Add `https://github.com/context-sdk/context-sdk-releases.git` as a dependency in Xcode Package Dependencies or in your `Package.swift` file:

```swift
dependencies: [
    .package(url: "https://github.com/context-sdk/context-sdk-releases", .upToNextMajor(from: "5.17.0")),
]
```

{% endtab %}

{% tab title="CocoaPods" %}
Add the following dependency to your `Podfile` and run `pod install` :

{% code title="Podfile" %}

```ruby
pod "ContextSDK"
```

{% endcode %}
{% endtab %}

{% tab title="Manually" %}

1. Download the latest version of ContextSDK: [ContextSDK.zip](https://storage.googleapis.com/de73e410-context-sdk-releases/latest/ContextSDK.zip)
2. In Xcode, drag `ContextSDK.xcframework` into the Project Navigator.
3. Open your project settings, navigate to `Frameworks, Libraries, and Embedded Content`, add `ContextSDK.xcframework`, and set it to `Embed & Sign`.

To download a specific version, replace `latest` in the download URL with the desired version number. For example, to download version 5.17.0:

<https://storage.googleapis.com/de73e410-context-sdk-releases/5.17.0/ContextSDK.zip>
{% endtab %}
{% endtabs %}

**SDK Initialization**

{% tabs %}
{% tab title="UIKit" %}

<pre class="language-swift" data-title="AppDelegate.swift" data-overflow="wrap"><code class="lang-swift">import ContextSDK

class AppDelegate: NSObject, UIApplicationDelegate {
    // …
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        // …
<strong>        ContextManager.applicationDidFinishLaunchingWithOptions(launchOptions, licenseKey: "YOUR_LICENSE_KEY")
</strong>        // …
    }
}
</code></pre>

{% endtab %}

{% tab title="SwiftUI" %}

1. Create an `AppDelegate` class if you don't have one yet:

{% code title="AppDelegate.swift" overflow="wrap" %}

```swift
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
    }
}
```

{% endcode %}

2. If you didn't have an `AppDelegate` class yet, add a `UIApplicationDelegateAdaptor` property wrapper to your `App` scene:

{% code title="YourApp.swift" %}

```swift
struct YourApp: App {
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
    // …
}
```

{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="Android" %}
**Installation**

{% hint style="warning" %}
**Note:** Android support is currently in beta. To obtain a license key, contact us at <support@contextsdk.com>
{% endhint %}

{% tabs %}
{% tab title="Kotlin" %}
Add the ContextSDK Maven repository in your project-level `settings.gradle.kts`:

{% code title="settings.gradle.kts" %}

```java
dependencyResolutionManagement {
    repositories {
        // …
        // Add the ContextSDK Maven repo:
        maven {
            url = uri("https://storage.googleapis.com/fc4073e9-contextsdk-maven/")
        }
    }
}
```

{% endcode %}

Add the ContextSDK dependency in your module-level `build.gradle.kts`:

{% code title="build.gradle.kts" %}

```java
dependencies {
    // …
    implementation("com.contextsdk:contextsdk:<version>")
}
```

{% endcode %}
{% endtab %}

{% tab title="Java" %}
Add the ContextSDK Maven repository in your project-level `settings.gradle`:

<pre class="language-java" data-title="settings.gradle"><code class="lang-java"><strong>dependencyResolutionManagement {
</strong>    repositories {
        // …
        // Add the ContextSDK maven repo:
        maven {
            url 'https://storage.googleapis.com/fc4073e9-contextsdk-maven/'
        }
    }
}
</code></pre>

Add the ContextSDK dependency in your module-level `build.gradle`:

{% code title="build.gradle" %}

```java
dependencies {
    // …
    implementation 'com.contextsdk:contextsdk:<version>'
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

Replace `<version>` with the latest release.

**SDK Initialization**

{% tabs %}
{% tab title="Kotlin" %}
In your `Application` subclass, initialize ContextSDK by calling `setup` with your license key:

```kotlin
class MainApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        ContextSDK.setup(this, "YOUR_LICENSE_KEY")
    }
}
```

{% endtab %}

{% tab title="Java" %}
In your `Application` subclass, initialize ContextSDK by calling `setup` with your license key:

```java
public class MainApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        ContextSDK.Companion.setup(this, "YOUR_LICENSE_KEY", new ContextSDKConfiguration());
    }
}
```

{% endtab %}
{% endtabs %}

That's all the setup there is: from `setup` on, ContextSDK observes every `Activity` in your app by itself, including ones from other libraries such as an ad network's full-screen ad or a billing screen. It collects accelerometer and gyroscope data while any of them is in the foreground, and stops once the app has been in the background for 5 seconds. There is nothing to call per `Activity`.

{% hint style="info" %}
Call `setup` once, from `Application.onCreate()`. Only the first call takes effect: any later call logs a warning and is ignored, including its license key and configuration. To change either, change the arguments of that first call.
{% endhint %}

`setup` returns whether this call activated ContextSDK with a valid license key. It returns `false` when the license key isn't valid for your app's package name (ContextSDK then keeps its events on the device instead of uploading them), when an earlier call already set ContextSDK up, when it's called outside your app's main process, and when setup failed. You can use it to report a misconfigured license key at runtime instead of only in logcat.
{% endtab %}

{% tab title="Flutter" %}
**Installation**

Add `context_sdk` to your `pubspec.yaml`:

{% code title="pubspec.yaml" %}

```yaml
dependencies:
  context_sdk: ^latest_version
```

{% endcode %}

Ensure your project meets the [Minimum SDK Requirements](https://docs.contextsdk.com/other/minimum-sdk-requirements.md) target by updating your `ios/Podfile`, e.g.:

{% code title="ios/Podfile" %}

```ruby
platform :ios, "15.0"
```

{% endcode %}

**SDK Initialization**

Add the following code to your app’s launch:

```dart
import 'package:context_sdk/context_sdk.dart';

final _contextSdkPlugin = ContextSdk();

_contextSdkPlugin.setup("YOUR_LICENSE_KEY");
```

{% endtab %}

{% tab title="Unity" %}
**Installation**

1. Download the latest version of ContextSDK: [ContextSDK.zip](https://storage.googleapis.com/de73e410-context-sdk-releases/latest/ContextSDK.zip).
2. In your Unity project, drag `ContextSDK.xcframework` into the `Assets/Plugins/iOS` folder.
3. Add the `ContextSDKBinding.cs` script 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.17.0:

<https://storage.googleapis.com/de73e410-context-sdk-releases/5.17.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:

```csharp
using static ContextSDKBinding;

public class InitContextSDK : MonoBehaviour
{
    void Start()
    {
        ContextSDKBinding.SetupWithAPIBackend("YOUR_LICENSE_KEY");
    }
}
```

**Android**

On Android, use the latest [`ContextSDKBinding.cs`](https://storage.googleapis.com/de73e410-context-sdk-releases/unity/latest/ContextSDKBinding.cs), add `com.contextsdk:contextsdk` to your Android Gradle build as shown in the Android tab, and call `SetupWithAPIBackend` as on iOS.
{% endtab %}

{% tab title="React Native" %}
**Installation**

Install ContextSDK using your preferred package manager:

```sh
npm install react-native-context-sdk@latest
```

or

```sh
yarn add react-native-context-sdk
```

Ensure your project meets the [Minimum SDK Requirements](https://docs.contextsdk.com/other/minimum-sdk-requirements.md) target by updating your `ios/Podfile`, e.g.:

{% code title="ios/Podfile" %}

```ruby
platform :ios, "15.0"
```

{% endcode %}

**SDK Initialization**

Add the following code to your app’s launch:

```js
import { setup } from "react-native-context-sdk";

void setup("YOUR_LICENSE_KEY");
```

{% endtab %}
{% endtabs %}

## 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](https://docs.contextsdk.com/context-decision/logging-conversions.md).

## ContextPush

ContextPush improves the timing of non-transactional push notifications by leveraging user's real-life context. To begin integrating ContextPush, see [Set Up Client Integration](https://docs.contextsdk.com/context-push/integration.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.contextsdk.com/basics/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
