SDK Móvil - Android

Repositorio: https://github.com/KlipFit/kleep-android

Instalación

Este proceso solo debe seguirse una vez, la primera vez que necesites instalar el SDK en tu proyecto. Consulta la sección Actualización para ver las instrucciones de actualizaciones posteriores. El SDK se distribuye a través de un repositorio Maven privado de Cloudsmith.

Añade tus credenciales de Cloudsmith

En tu local.properties, añade las credenciales proporcionadas por Kleep:

local.properties

cloudsmithUser=token
cloudsmithApiKey=TOKEN_VALUE

Sustituye TOKEN_VALUE por el token proporcionado por Kleep. El nombre de usuario es la cadena literal token.

Añade el repositorio Maven de Cloudsmith

En tu settings.gradle o settings.gradle.kts, añade las siguientes líneas:

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") ?: ""
            }
        }
    }
}

Añade la dependencia

En el archivo build.gradle o build.gradle.kts de tu módulo, añade las siguientes líneas para crear la dependencia:

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

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

Instalación heredada (JitPack)

Estas instrucciones se aplican a versiones anteriores del SDK distribuidas a través de JitPack.

En tu gradle.properties, añade este token: authToken=jp_9ibcequhrjtge3cmavt2k4sq6a

En tu settings.gradle o settings.gradle.kts, añade las siguientes líneas:

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

En el archivo build.gradle o build.gradle.kts de tu módulo, añade las siguientes líneas para crear la dependencia:

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

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

Inicialización

Edita tu clase Application personalizada y proporciona applicationContext para la inicialización.

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

class CustomApplication: Application() {

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

No olvides añadir tu clase Application a Manifest.xml

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

Importar

Puedes importar manualmente el módulo al principio de tu MainActivity.kt

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

Uso

El SDK incluye 3 métodos:

método	tiempo de carga
`show`	Primera ejecución: 250ms
Siguientes ejecuciones: 50-250ms
`requestSize`	250ms
`track`	250ms

Método 1: `requestSize`

Este método permite implementar la lógica del CTA. Esquema lógico Este esquema explica cómo actualizar el CTA que abre Kleep. https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1&t=ccXWciNziIdfhgew-1 Ejemplo de implementación

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()
}

Método 2: `show`

Este método se llama cuando se hace clic en el CTA. Permite cargar las diferentes pantallas. El desarrollador que integra el SDK debe embebidos en un bottom sheet.

parámetro	prioridad	descripción
productID	obligatorio	El ID de tu producto
retailer	obligatorio	Nombre del comerciante
customerID	opcional	Identificador CRM, usado para analíticas
trackingID	opcional	ID usado por el proveedor de seguimiento externo
stocks	opcional	Un mapa de IDs de variante de artículo a su estado de stock. `true` para en stock, `false` (por defecto) para sin stock, emptyMap o no especificado para omitir la verificación.

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()

Método 3: `track`

Este método permite rastrear eventos personalizados.

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

Queremos rastrear 3 eventos:

eventName	Disparador
`product_viewed`	Al visualizar la PDP
`product_added_to_cart`	Al añadir producto al carrito
`checkout_completed`	Tras la confirmación del pedido después del pago

product_viewed Parámetros (CSV) Ejemplo

{
		productId: str
}

product_added_to_cart Parámetros (CSV) Ejemplo

{
    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 Parámetros (CSV) Ejemplo

{
    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"
				}
	    }
	    ...
    ],
}

Bienvenida

CMS

Móvil

Panel

Datos

Privacidad

SDK Móvil - Android

Instalación

Inicialización

Importar

Uso

Método 1: `requestSize`

Método 2: `show`

Método 3: `track`

​Instalación

​Inicialización

​Importar

​Uso

​Método 1: requestSize

​Método 2: show

​Método 3: track

Instalación

Inicialización

Importar

Uso

Método 1: `requestSize`

Método 2: `show`

Método 3: `track`