Mobile SDK - Android

Repositório: https://github.com/KlipFit/kleep-android

Instalação

Este processo precisa ser seguido apenas uma vez, na primeira vez que você precisar instalar o SDK no seu projeto. Consulte a seção Atualização para ver as instruções de atualizações subsequentes. O SDK é distribuído por meio de um repositório Maven privado do Cloudsmith.

Adicione suas credenciais do Cloudsmith

No seu local.properties, adicione as credenciais fornecidas pela Kleep:

local.properties

cloudsmithUser=token
cloudsmithApiKey=TOKEN_VALUE

Substitua TOKEN_VALUE pelo token fornecido pela Kleep. O nome de usuário é a string literal token.

Adicione o repositório Maven do Cloudsmith

No seu settings.gradle ou settings.gradle.kts, adicione as seguintes linhas:

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

Adicione a dependência

No arquivo build.gradle ou build.gradle.kts do seu módulo, adicione as seguintes linhas para criar a dependência:

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

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

Instalação legada (JitPack)

Estas instruções se aplicam a versões mais antigas do SDK distribuídas via JitPack.

No seu gradle.properties, adicione este token: authToken=jp_9ibcequhrjtge3cmavt2k4sq6a

No seu settings.gradle ou settings.gradle.kts, adicione as seguintes linhas:

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

No arquivo build.gradle ou build.gradle.kts do seu módulo, adicione as seguintes linhas para criar a dependência:

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

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

Inicialização

Edite sua classe Application personalizada e forneça o applicationContext para inicialização.

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

class CustomApplication: Application() {

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

Não se esqueça de adicionar sua classe Application ao Manifest.xml

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

Importação

Você pode importar o módulo manualmente no início do seu MainActivity.kt

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

Uso

O SDK possui 3 métodos:

método	tempo de carregamento
`show`	Primeiro lançamento: 250ms
Lançamentos seguintes: 50-250ms
`requestSize`	250ms
`track`	250ms

Método 1: `requestSize`

Este método permite implementar a lógica do CTA. Esquema de lógica Este esquema explica como atualizar o CTA que abre o Kleep. https://www.figma.com/board/BlurZ01lR3JBQZeTUU98TE/Mobile---CTA-Logic?node-id=0-1&t=ccXWciNziIdfhgew-1 Exemplo de implementação

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 é chamado quando o CTA é clicado. Ele permite carregar as diferentes telas. O desenvolvedor que integra o SDK deve incorporá-las em um bottom sheet.

parâmetro	prioridade	descrição
productID	obrigatório	ID do seu produto
retailer	obrigatório	Nome do varejista
customerID	opcional	Identificador CRM, usado para analytics
trackingID	opcional	ID usado por provedor de rastreamento externo
stocks	opcional	Um mapa de IDs de variantes de itens para seu status de estoque.
`true` para em estoque, `false` (padrão) para fora de estoque, emptyMap ou não especificado para pular a verificação.

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	Acionador
`product_viewed`	Ao visualizar a PDP
`product_added_to_cart`	Ao adicionar produto ao carrinho
`checkout_completed`	Ao confirmar pedido após o pagamento

product_viewed Parâmetros (CSV) Exemplo

{
		productId: str
}

product_added_to_cart Parâmetros (CSV) Exemplo

{
    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) Exemplo

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

Bem-vindo

CMS

Mobile

Painel

Dados

Privacidade

Mobile SDK - Android

Instalação

Inicialização

Importação

Uso

Método 1: `requestSize`

Método 2: `show`

Método 3: `track`

​Instalação

​Inicialização

​Importação

​Uso

​Método 1: requestSize

​Método 2: show

​Método 3: track

Instalação

Inicialização

Importação

Uso

Método 1: `requestSize`

Método 2: `show`

Método 3: `track`