Mobile SDK - Android

Version history: see Android SDK - Version history for the latest version and the changes in each release.

Installation

This process needs to be followed only once, the first time you need to install the SDK in your project. To update the SDK later, change the version in the dependency (see the version history). The SDK is distributed through a private Cloudsmith Maven repository.

Add your Cloudsmith credentials

In your local.properties, add the credentials provided by Kleep:

local.properties

cloudsmithUser=token
cloudsmithApiKey=TOKEN_VALUE

Replace TOKEN_VALUE with the token provided by Kleep. The username is the literal string token.

Add the Cloudsmith Maven repository

In your settings.gradle or settings.gradle.kts, add the following lines:

val localProps = java.util.Properties().apply {
    val localFile = file("local.properties")
    if (localFile.exists()) load(localFile.inputStream())
}

dependencyResolutionManagement {
// ...
    repositories {
        // ...
        maven {
            url = uri("https://dl.cloudsmith.io/basic/kleep/kleep-android/maven/")
            credentials {
                username = localProps.getProperty("cloudsmithUser") ?: ""
                password = localProps.getProperty("cloudsmithApiKey") ?: ""
            }
        }
    }
}

def localProps = new Properties()
def localFile = file("local.properties")
if (localFile.exists()) localProps.load(localFile.newDataInputStream())

dependencyResolutionManagement {
// ...
    repositories {
        // ...
        maven {
            url "https://dl.cloudsmith.io/basic/kleep/kleep-android/maven/"
            credentials {
                username = localProps.getProperty("cloudsmithUser") ?: ""
                password = localProps.getProperty("cloudsmithApiKey") ?: ""
            }
        }
    }
}

Add the dependency

In your module’s build.gradle or build.gradle.kts file, add the following lines to create the dependency:

dependencies {
    implementation 'com.klipfit:kleep-android:version'
}

dependencies {
    implementation("com.klipfit:kleep-android:version")
}

Replace version with the latest version from the version history, including the leading v: for example com.klipfit:kleep-android:v4.1.9.

Legacy installation (JitPack)

These instructions apply to older SDK versions distributed through JitPack.

In your gradle.properties, add this token: authToken=jp_9ibcequhrjtge3cmavt2k4sq6a

In your settings.gradle or settings.gradle.kts, add the following lines:

dependencyResolutionManagement {
// ...
    repositories {
        // ...
        maven {
            url "https://jitpack.io"
            credentials { username authToken }
        }
    }
}

dependencyResolutionManagement {
// ...
    repositories {
        // ...
        maven {
            url = uri("https://jitpack.io")
            credentials(PasswordCredentials::class) {
                val authToken: String by settings
                username = authToken
            }
        }
    }
}

In your module’s build.gradle or build.gradle.kts file, add the following lines to create the dependency:

dependencies {
    implementation 'com.github.KlipFit:kleep-android:version'
}

dependencies {
    implementation("com.github.KlipFit:kleep-android:version")
}

Initialization

Edit your custom Application class and provide applicationContext for initialization.

import com.kleep.sdk.KleepResult
import com.kleep.sdk.Kleep

class CustomApplication: Application() {

    override fun onCreate() {
        super.onCreate()
        Kleep.init(applicationContext)
    }
}

Don’t forget to add your Application class to AndroidManifest.xml

<application
        android:name=".CustomApplication"
        ...
        >
...
</application>

Import

You can manually import the module at the beginning of your MainActivity.kt

import com.kleep.sdk.KleepResult
import com.kleep.sdk.Kleep

Usage

The SDK comes with 3 methods:

method	loadtime
`show`	First launch: 250ms Next launches: 50-250ms
`requestSize`	250ms
`track`	250ms

Method 1: `requestSize`

This method allows to implement the logic of the CTA. Logic schema This schema explains how to update the CTA opening Kleep. https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1&t=ccXWciNziIdfhgew-1 Implementation example

Kleep.builder(this, onResult = {
	when (it) {
	    is KleepResult.NotSupported -> {
	        // Handle the NotSupported case
	    }
	
	    is KleepResult.NoRecommendationYet -> {
	        // Handle the NoRecommendationYet case
	    }
	
	    is KleepResult.RecommendationFound -> {
	        val resultText = it.size
	        val variantId = it.variantId
	        Toast.makeText(this, resultText, Toast.LENGTH_SHORT).show()         
      }

      else -> {

      }
    }
})
	.setPackageName(packageName)         // optional
	.setLang(DEFAULT_LANGUAGE)           // required: "fr", "en", "es", "it", "pt", "nl"
	.setProductId("1234")                // required
	.setRetailer("retailer_name")        // required
	.setTrackingId("uuid")               // empty if non-existent 
	.setCustomerId("unique_customer_id") // optional
	.requestSize()

package com.kleep.sdk

/**
 * Interface with the Kleep SDK in order to compute the recommended size of a product given some user information
 */
interface KleepDialogBuilder {
    /**
     * Set the package name, not required
     * @return interface of the SDK builder
     */
    fun setPackageName(packageName: String): KleepDialogBuilder
    
    /**
     * Set the language to use: required (default to FR)
     * Values supported: "fr", "en", "es", "it", "pt", "nl"
     * @return interface of the SDK builder
     */
    fun setLang(lang: String): KleepDialogBuilder

    /**
     * Set product ID, required to compute the recommended size.
     * @return interface of the SDK builder
     */
    fun setProductId(productId: String): KleepDialogBuilder

    /**
     * Set tracking id, required. Should represent unique tracking id.
     * Should be an empty string if the tracking id does not exist.
     *
     * @return interface of the SDK builder
     */
    fun setTrackingId(tracking_id: String): KleepDialogBuilder

    /**
     * Set customer id, optonal. Should represent customer id linked to backend.
     * Should be an empty string if the tracking id does not exist.
     *
     * @return interface of the SDK builder
     */
    fun setCustomerId(customer_id: String): KleepDialogBuilder
    
    /**
     * Set retail name (mandatory), required for stock/similar_products requests.
     *
     * @return interface of the SDK builder
     */
    fun setRetailer(retailerName: String): KleepDialogBuilder
    
    /**
     * Sets the stock availability for items.
     * Providing an empty map or omitting this function disables stock checking.
     *
     * @return interface of the SDK builder
     */
    fun setStocks(stocks: Map<String, Boolean>): KleepDialogBuilder

    /**
     * Display the Kleep UI inside a BottomSheet, so the user can fill a survey or take 2 pictures
     * in order to compute and display the recommended size to the user
     */
    fun show()

    /**
     * Get the latest recommended size for the last viewed user.
     * As it's an async process and take several seconds,
		 * the result will be give by the onResult listener , provided to the SDK builder
     */
    fun requestSize()
}

The SDK currently supports 6 UI languages, passed via setLang:

Supported languages (6)

fr — French (default)
en — English
es — Spanish
it — Italian
pt — Portuguese
nl — Dutch

If a language you need isn’t in the list, contact your Kleep representative.

Method 2: `show`

This method is called when the CTA is clicked. It allows to load the different screens. The developper integrating the SDK should embed them into a bottom sheet.

parameter	priority	description
productID	required	You product ID
retailer	required	Name of the retailer
customerID	optional	CRM identifier, used for analytics
trackingID	optional	ID used by external tracking provider
stocks	optional	A map of item variant IDs to their stock status. `true` for in stock, `false` (by default) for out of stock, emptyMap or not specified to skip the check.

Kleep.builder(this, onResult = {
	when (it) {
	    is KleepResult.NotSupported -> {
	        // Handle the NotSupported case
	    }
	
	    is KleepResult.NoRecommendationYet -> {
	        // Handle the NoRecommendationYet casem
	    }
	
	    is KleepResult.RecommendationFound -> {
	        val resultText = it.size
	        val variantId = it.variantId
	        // addToCart(variantId)
	        
	        Toast.makeText(this, resultText, Toast.LENGTH_SHORT).show()
      }

      else -> {

      }
    }
})
	.setPackageName(packageName)         // optional
	.setLang(DEFAULT_LANGUAGE)           // required: "fr", "en", "es", "it", "pt", "nl"
	.setProductId("1234")                // required
	.setRetailer("retailer_name")        // required
	.setTrackingId("tracking_id")        // optional
	.setCustomerId("unique_customer_id") // optional
	.setStocks(stocks: Map<String, Boolean>) // optional
	.show()

Method 3: `track`

This method allows to track custom events.

Kleep.track(eventName: String, eventInfo: Map<String, String>)

We want to track 3 events:

eventName	Trigger
`product_viewed`	Upon PDP viewed
`product_added_to_cart`	Upon product added to the cart
`checkout_completed`	Upon order confirmation after the payment

product_viewed Parameters

Property	Type	Description	Priority
`productId`	String	The ID of the product matching the Product Catalog feed.	required

Example

{
		productId: str
}

product_added_to_cart Parameters

Property	Type	Description	Priority
`productId`	String	The ID of the product matching the Product Catalog feed.	required
`variantId`	String	The ID of the variant matching the Product Catalog feed.	required
`cart`	Array	An array containing the updated information of the cart’s products.	optional
`cart[].productId`	String	The ID of the product matching the Product Catalog feed.	required
`cart[].variantId`	String	The ID of the variant matching the Product Catalog feed.	required
`cart[].sku`	String	Product’s SKU	optional
`cart[].ean`	String	Product’s EAN	optional
`cart[].size`	String	Label of the size of the product in the cart.	required
`cart[].quantity`	Number	Number of items in the cart.	required
`cart[].price`	Object	Price of the product.	optional
`cart[].price.amount`	String	Amount to pay for the item	optional
`cart[].price.currencyCode`	String	EUR, USD…	optional

Example

{
    productId: str,
    variantId: str,
    cart: [
	    {
		    productId: "123ABC456",
		    variantId: "123ABC456-00R",
				sku: "XYZ",
		    size: "S",
		    quantity: 2,
		    price: {
						amount: "50",
				    currencyCode: "EUR"		    
		    }
	    },
	    {
		    productId: "123ABC456",
		    variantId: "123ABC456-00R",
		    sku: "XYZ",
		    size: "S",
		    quantity: 1,
		    price: {
				    amount: "40",
				    currencyCode: "USD"
				}
	    }
	    ...
    ],
}

checkout_completed Parameters

Property	Type	Description	Priority
`orderId`	String	The ID of the order matching the Order Data feed.	required
`cart`	Array	An array containing the information of the ordered products.	optional
`cart[].lineItemId`	String	The ID of the cart line item matching the Order Data feed.	required
`cart[].productId`	String	The ID of the product matching the Product Catalog feed.	required
`cart[].variantId`	String	The ID of the variant matching the Product Catalog feed.	required
`cart[].sku`	String	Product’s SKU	optional
`cart[].ean`	String	Product’s EAN	optional
`cart[].size`	String	Label of the size of the product in the cart.	required
`cart[].quantity`	Number	Number of items in the cart.	required
`cart[].price`	Object	Price of the product.	optional
`cart[].price.amount`	String	Amount to pay for the item	optional
`cart[].price.currencyCode`	String	EUR, USD…	optional

Example

{
    orderId: "000001",
    cart: [
	    {
		    lineItemId: "000001#1",
		    productId: "123ABC456",
		    variantId: "123ABC456-00R",
				sku: "XYZ",
		    size: "S",
		    quantity: 2,
		    price: {
						amount: "50",
				    currencyCode: "EUR"		    
		    }
	    },
	    {
			  lineItemId: "000000#2",
		    productId: "123ABC456",
		    variantId: "123ABC456-00R",
		    sku: "XYZ",
		    size: "S",
		    quantity: 1,
		    price: {
				    amount: "40",
				    currencyCode: "USD"
				}
	    }
	    ...
    ],
}

A/B testing

Kleep runs experiments on parts of the sizing flow (CTA copy, layout, timing) to keep improving conversion, using the same experimentation layer already used across Kleep’s web integrations, built on PostHog. PostHog is embedded inside the Kleep SDK — you don’t need to add the PostHog SDK yourself, request any extra permission, or call any additional method. Here’s how the variant assignment flows internally: The assignment is keyed on a stable on-device ID, so a given install keeps seeing the same variant for the duration of the experiment instead of being re-rolled on every launch. You don’t read or set the variant yourself — Kleep resolves it internally and reports the conversion delta per variant on its side.

Welcome

CMS

Mobile

Data

Privacy

Mobile SDK - Android

Installation

Initialization

Import

Usage

Method 1: `requestSize`

Method 2: `show`

Method 3: `track`

A/B testing

​Installation

​Initialization

​Import

​Usage

​Method 1: requestSize

​Method 2: show

​Method 3: track

​A/B testing

Installation

Initialization

Import

Usage

Method 1: `requestSize`

Method 2: `show`

Method 3: `track`

A/B testing