SDK 1.4.0 - merci-app/mcikit-sample-android GitHub Wiki
- Android Version: 4.3 ou superior
- Kotlin: 1.3.31 ou superior
- Androidx
Para configurar Merci-Kit em seu projeto primeiro adicione no root do seu build.gradle o
repositório que irá permitir o download do mci-kit:
maven { url 'https://jitpack.io' } //Permite o funcionamento de algumas dependências do mci-kit
maven { url '<nossa-url-repo-privada>' } Em seguida adicione a dependência a base do nosso SDK mci-kit no gradle do seu aplicativo:
dependencies {
implementation 'kit.merci:mci-kit:1.4.0'
}
A framework deverá ser iniciada no método onCreate do seu Application :
Merci.instantiate(
application = this,
clientId = "<seu-client-id>",
clientSecret = "<seu-client-secret>",
environment = Environment.SANDBOX ou Environment.PRODUCTION,
clientProvider = SuaClasseClientProvider()
)
O parâmetro clientProvider pode ser uma classe sua que herda de ClienteProvider, útil para que
sua app seja notificada sempre que o mci-kit necessite solicitar algo, por exemplo:
class SuaClasseClientProvider : ClientProvider() {
/**
* Sempre que for identificado que o usuáio não esta autenticado iremos
* notificar o seu app a partir dessa função.
**/
override fun authenticate() {
}
/**
* Sempre que o usuário clicar nas ações de Solicitar Suporte dentro do mci-kit iremos * notificar seu app a partir dessa função
**/
override fun supportRequested(context: Context) {
}
/**
Eventos de Analytics trackeados dentro do SDK serão notificados nessa função de callback
**/
override fun onEvent(name: String, params: Map<String, Any>) {
}
}
Para utilizar os recursos da framework é necessário autenticar o usuário como exibido a seguir:
Merci.authenticate(vatNumber = "<cpf-do-usuario>", object: MCICallback {
override fun onSuccess() {
}
override fun onError(e: Throwable) {
}
}) Para realizar o logout:
Merci.revokeAuthentication() Para checar se o usuário esta autenticado na nossa plataforma:
Merci.isAuthenticated() O proceso de autenticação deve ocorrer uma única vez. Sugerimos efetuar a autenticação da SDK Merci logo após efetuarem o processo de login do seu aplicativo. Sempre que o usuário efetuar logout em seu aplicativo, é obrigatório chamar o método Revoke em nossa SDK.
Primeiro é necessário adicionar a dependência desse modulo no seu gradle:
dependencies {
implementation 'kit.merci:mci-market-place:<número-da-versão>'
} Para iniciar Market Pay é necessário chamar o método de launch da seguinte forma:
Merci.launch(this, MarketPay)
Para iniciar uma venda direta, é necessário chamar o método abaixo, informando o identifcador do estabelecimento como mostra a seguir:
try {
Merci.launch(this, Merchant("<merchant-id>"))
} catch (e: MerchantNotFound) {
// Será enviado uma Exception caso o Merchant não seja encontrato em nossa plataforma
}
Primeiro é necessário adicionar a dependência desse modulo no seu gradle:
dependencies {
implementation 'kit.merci:mci-pay:<número-da-versão>'
} Para iniciar o módulo de pagar, é necessário chamar o método de launch da seguinte forma:
Merci.launch(this, Payment)
Primeiro é necessário adicionar a dependência desse modulo no seu gradle:
dependencies {
implementation 'kit.merci:mci-withdraw:<número-da-versão>'
} Para iniciar o módulo de sacar, é necessário chamar o método de launch da seguinte forma:
Merci.launch(this, Withdraw)
O mci-kit permite que o cliente altere a identidade visual dos principais pontos do framework. Para fazer isso é necessário definir os seguintes parametros:
<item name="homeBackgroundColor" type="color"><!-- Cor de fundo da home --></item>
<item name="homeTitleColor" type="color"><!-- Cor de texto dos botões de categoria da home --></item>
<item name="actionTintColor" type="color"><!-- Cor dos botões de ação --></item>
<item name="actionTextTintColor" type="color"><!-- Cor do texto dos botões de ação --></item>
<item name="actionBarTintColor" type="color"><!-- Cor dos botões da ActionBar --></item>
<item name="loadingTintColor" type="color"><!-- Cor do loading --></item>
<item name="homeImage" type="drawable"><!-- Imagem de logo que será exibida na ToolBar --></item>
<item name="brandImage" type="drawable"><!-- Imagem que será exibida na transação --></item>
<item name="clientName" type="string"><!-- Identificação do cliente que irá ser exibido nas UIs onde necessitar exibir o nome do cliente --></item>Eventos trackeados dentro do SDK que serão notificados na função onEvent no ClientProvider. Os objetos expostos nas notificações serão todos no padrão JSON, permitindo a fácil leitura por qualquer plataforma.
------------------------------------------------------------------------
MerciSDK_UserAuthenticationNotification:
{
"timestamp": "1573728019",
"status": "authenticaded|revoked"
}
------------------------------------------------------------------------
MerciSDK_ModulePresentationNotification:
{
"timestamp": "1573728019",
"module": "marketplace|payment|wallet",
"status": "presented|dismissed"
}
------------------------------------------------------------------------
MerciSDK_MerchantPresentationNotification:
{
"timestamp": "1573728019",
"merchant": {
"id": "66a42b85-6c02-455b-a3e2-f4ebea478e63",
"name": "Uber Pré-Pago"
},
"status": "presented|dismissed"
}
------------------------------------------------------------------------
MerciSDK_TransactionNotification:
{
"timestamp": "1573728019",
"merchant": {
"id": "66a42b85-6c02-455b-a3e2-f4ebea478e63",
"name": "Uber Pré-Pago"
},
"amount": 123.45,
"status": "started|canceled|failed|completed"
}
------------------------------------------------------------------------
Caso seu projeto utilize uma dessas ferramentas de obfuscação será necessário adicionar as seguintes regras no seu proguard-rules.pro:
# mci-kit rules
-keep class kit.merci.data.model.** { *; }
-keep class kit.merci.data.network.requests.** { *; }
-keep class kit.merci.data.network.response.** { *; }
-keep class app.merci.merchant.taxis99.data.model.** { *; }
-keep class app.merci.merchant.taxis99.data.network.request.** { *; }
-keep class app.merci.merchant.taxis99.data.network.response.** { *; }
-keep class foundation.merci.external.** { *; }