SDK Mobile - Android

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

Instalação

Este processo só precisa de ser seguido uma vez, na primeira vez que instala o SDK no seu projeto. Consulte a secção Atualização para ver as instruções para atualizações subsequentes. O SDK é distribuído através de um repositório Maven privado da Cloudsmith.

Adicione as suas credenciais 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 utilizador é a string literal token.

Adicione o repositório Maven da 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 ficheiro 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 antiga (JitPack)

Estas instruções aplicam-se a versões mais antigas do SDK distribuídas através do 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 ficheiro 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 a sua classe Application personalizada e forneça o applicationContext para a 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 a sua classe Application ao Manifest.xml

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

Importação

Pode importar manualmente o módulo no início do seu MainActivity.kt

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

Utilização

O SDK inclui 3 métodos:

método	tempo de carregamento
`show`	Primeiro arranque: 250ms
Arranques seguintes: 50-250ms
`requestSize`	250ms
`track`	250ms

Método 1: `requestSize`

Este método permite implementar a lógica do CTA. Esquema lógico 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. Permite carregar os diferentes ecrãs. O programador que integra o SDK deve incorporá-los numa bottom sheet.

parâmetro	prioridade	descrição
productID	obrigatório	O seu ID de produto
retailer	obrigatório	Nome do retalhista
customerID	opcional	Identificador CRM, utilizado para análise
trackingID	opcional	ID utilizado por fornecedor de tracking externo
stocks	opcional	Um mapa de IDs de variantes de artigos para o seu estado de stock.
`true` para em stock, `false` (por padrão) para esgotado, emptyMap ou não especificado para ignorar 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 fazer o tracking de eventos personalizados.

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

Pretendemos fazer o tracking de 3 eventos:

eventName	Acionador
`product_viewed`	Quando o PDP é visualizado
`product_added_to_cart`	Quando o produto é adicionado ao carrinho
`checkout_completed`	Quando a encomenda é confirmada 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

SDK Mobile - Android

Instalação

Inicialização

Importação

Utilização

Método 1: `requestSize`

Método 2: `show`

Método 3: `track`

​Instalação

​Inicialização

​Importação

​Utilização

​Método 1: requestSize

​Método 2: show

​Método 3: track

Instalação

Inicialização

Importação

Utilização

Método 1: `requestSize`

Método 2: `show`

Método 3: `track`