Sovendus Android SDK Integration Guide

Quick Start Checklist

1. ✅ Add dependency to build.gradle.kts
2. ✅ Get credentials from Sovendus
3. ✅ Add one component to your app
4. ✅ Test with sandbox mode
5. ✅ Go live with production credentials

Step 1: Installation

dependencies {
    implementation("com.sovendus:android-sdk:1.1.0")
}

Step 2: Get Credentials

• Traffic Source Number (e.g., 123)
• Traffic Medium Number (e.g., 456)

Step 3: Add the Component

Compose (Recommended)

@Composable
fun YourScreen() {
    // Each VoucherBenefits instance uses a unique trafficMediumNumber
    SovendusSDK.VoucherBenefits(
        config = SovendusConfig.Builder()
            .trafficSourceNumber(123)
            .trafficMediumNumber(

XML (Traditional)

<com.sovendus.sdk.ui.xml.SovendusVoucherBenefitsView
    android:id="@+id/sovendus_benefits"
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

findViewById<SovendusVoucherBenefitsView>(R.id.sovendus_benefits).apply {
    config = SovendusConfig.Builder()
        .trafficSourceNumber(123)
        .trafficMediumNumber(456)  

Step 4: Test Your Integration

val testConfig = SovendusConfig.Builder()
    .sandbox(true)  // Uses test data
    .build()

SovendusSDK.VoucherBenefits(config = testConfig)

Step 5: Add Personalization (Optional)

val config = SovendusConfig.Builder()
    .trafficSourceNumber(123)
    .trafficMediumNumber(456)
    .consumer(ConsumerData(
        firstName = "Max",
        email =

Step 6: Handle Loading States (Optional)

Custom Loading

SovendusSDK.VoucherBenefits(
    config = config,
    onStateChanged = { state ->
        when (state) {
            is LoadingState.Loading -> showYourLoader()
            is LoadingState

Step 7: Multiple Placements (Optional)

@Composable
fun YourApp() {
    // Placement 1: Inline benefits list + banner on checkout success page
    SovendusSDK.VoucherBenefits(
        config = SovendusConfig.Builder()
            .trafficSourceNumber(123)
            .trafficMediumNumber(

Modal/Dialog Placement

@Composable
fun ModalPlacement() {
    var showDialog by remember { mutableStateOf(false) }
    var dataReady by remember { mutableStateOf(false) }

    

• Each placement uses a unique trafficMediumNumber assigned by Sovendus
• Sovendus configures what content and layout each medium number returns
  • Inline placements: May return benefits list, banner, or both
  • Modal placements: Typically banner-only with overlay layout (layoutId 2)
• Each instance triggers its own independent API call
• The component renders whatever the API returns

Step 8: Customize Link Behavior (Optional)

val config = SovendusConfig.Builder()
    .trafficSourceNumber(123)
    .trafficMediumNumber(456)
    .onLinkOpened { url ->
        // Custom logic (e.g., Chrome Custom Tabs, in-app browser)
        openInCustomTabs(url

Step 9: Custom Fonts (Optional)

Bundling Fonts in Your App

1. Add font files to res/font/ directory (TTF or OTF format):

   app/src/main/res/font/
   ├── brand_regular.ttf
   └── brand_bold.ttf
   

2. Create a FontFamily with the font weights you need:

   import androidx.compose.ui.text.font.Font
   import androidx.compose.ui.
   

Using Variable Fonts

import androidx.compose.ui.text.ExperimentalTextApi
import androidx.compose.ui.text.font.FontVariation

@OptIn(ExperimentalTextApi::class)
val BrandVariableFontFamily = FontFamily(
    

Default Behavior

• If fontFamily is not provided (or set to null), the SDK uses the system font
• The custom font applies to all SDK text elements: headlines, body text, buttons, and footer links
• Font weights are preserved (Normal, Medium, SemiBold, Bold) - ensure your FontFamily includes the weights you need

Going to Production

1. Replace sandbox mode with real credentials:

   val config = SovendusConfig.Builder()
       .trafficSourceNumber(123)  // Your real traffic source
       .trafficMediumNumber(456)  // Your real traffic medium
       .debugMode(

Complete Examples

Minimal Integration (Compose)

@Composable
fun CheckoutSuccessScreen() {
    SovendusSDK.VoucherBenefits(
        config = SovendusConfig.Builder()
            .trafficSourceNumber(123)
            .trafficMediumNumber(456)  

Multiple Placements (Compose)

@Composable
fun CheckoutSuccessScreen() {
    // Placement 1: Inline content (Sovendus decides what to show)
    SovendusSDK.VoucherBenefits(
        config = SovendusConfig.Builder()
            .trafficSourceNumber(123)
            .trafficMediumNumber

XML Integration

class CheckoutSuccessActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout

Troubleshooting

Nothing appears on screen

• ✅ Check that you're using correct traffic numbers
• ✅ Verify network connectivity
• ✅ Enable debug mode to see errors: .debugMode(true)

Links don't open

• ✅ Ensure device has a browser app installed
• ✅ Check if custom link handler is working correctly

No personalized content

• ✅ Verify consumer and order data is provided
• ✅ Check that email format is valid

Need more help?

• 📖 Check the sample app for working examples
• 📧 Contact your Sovendus integration specialist

What Gets Displayed?

VoucherBenefits — The Single Component for All Placements

Layout Options

• The layout is determined by the API response (template.layoutId)
• No integrator action required—the SDK automatically renders the correct layout
• Sovendus configures the layout per trafficMediumNumber via backend settings

Multi-Placement Architecture

• What content to return (banner only, list only, or both)
• Which layout to use (inline vs overlay banner, horizontal slider vs vertical list)
• Themes and styling (colors, fonts, border radius)