KARTE is a real-time user analytics & action tool. This repository holds the source code for the Android version of KARTE SDK.

Getting Started

Please see the detailed instructions in our docs to add KARTE Android SDK to your Android Studio project.

Requirements

To integrate the KARTE Android SDK, the following requirements must be met:

• Kotlin 1.8.10 or higher
• Gradle 8.0.0 or higher
• Android Gradle Plugin: 8.1.1 or higher
• Optimizer: R8
• minSdkVersion 21 or higher

Requirements Update Policy

This section defines the policy for raising the minimum required versions of build tools and SDK dependencies.

targetSdk / compileSdk

Selection criteria: The latest stable Android SDK version

Update frequency: Approximately 6 months after the stable Android SDK release (typically January-February of the following year)

Update process:

• Begin impact analysis and internal testing during the beta phase
• Perform final validation after stable release

Rationale: Google Play Store requires apps to target recent API levels (typically within 12 months of release). Early adoption allows our customers sufficient time to update their applications.

Android Gradle Plugin (AGP) / Gradle / Kotlin / JDK

Selection criteria:

Based on the selected AGP version, we determine compatible versions for related build tools:

• AGP: Stable version released approximately one year before selection
• Gradle: Default version specified in AGP release notes
• Kotlin: Compatible version from the AGP compatibility matrix (or the previous major version if not explicitly listed)
• JDK: Default version specified in AGP release notes

Rationale:

• Balances stability and security through the use of well-established versions
• Default versions ensure officially verified compatibility between tools

Documentation

The developer guide is located at

• Developer Portal - KARTE Android SDK

The API references are located at

• Core
• InAppMessaging
• Notifications
• Variables
• VisualTracking
• Debugger
• InAppFrame

Getting Help

• Have a bug to report? Open a GitHub issue. If possible, include the OS version, SDK version and full logs.
• Have a feature request? Open a GitHub issue. Tell us what the feature should do and why you want the feature.

Contributing

Please follow our guidelines.

• Contribution Guideline
• Code of Conduct

License

KARTE Android SDK is published under the Apache 2.0 License.

Your use of KARTE is governed by the KARTE Terms of Use.