Guia de Instalação

Instale e configure o Certta para Android. Saiba mais sobre requisitos do SDK, permissões, repositórios, dependências, configuração de sessão, atualizações de token em tempo de execução e tema de cores.

Este guia abrange a versão 7.14.0 e superior. Para versões anteriores à 7.14.0, consulte a documentação legada.

Instalando o SDK para Android

Este guia o conduzirá por todo o processo de configuração necessário para baixar, configurar e instalar com sucesso o SDK em sua máquina

Requisitos

Antes de integrar, certifique-se de que seu ambiente atenda aos requisitos mínimos do Certta SDK:

Requisito

Versão

Versão mínima do SDK (minSdk)

Versão de compilação do Android (compileSDK)

Versão mínima do Kotlin

1.9.10

Versão do Gradle

8.4

Android Gradle Plugin (AGP)

8.3.2

Permissões

Para habilitar a funcionalidade de rede e câmera necessária para o Certta SDK, você deve declarar as permissões e os recursos de hardware apropriados no AndroidManifest.xml arquivo do seu projeto.

Adicione as seguintes linhas dentro do seu <manifest> tag:

AndroidManifest.xml

<uses-feature android:name="android.hardware.camera" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />

AndroidManifest.xml

<uses-feature android:name="android.hardware.camera" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

O Detector de Documentos requer READ_EXTERNAL_STORAGE permissão quando o envio de documentos estiver ativado.

Adicionando repositórios

Para baixar o Certta SDK, você deve informar ao seu projeto Android onde encontrar suas dependências. Isso é feito configurando o dependencyResolutionManagement bloco localizado na raiz do seu projeto settings.gradle.kts arquivo do seu projeto.

Adicione os URLs de repositório necessários à sua configuração:

Para projetos baseados em Groovy, inclua os seguintes repositórios no settings.gradle arquivo do seu projeto.

settings.gradle.kts

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        maven { url = uri("https://repo.combateafraude.com/android/release") }        
    }
}

settings.gradle

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        maven { url "https://repo.combateafraude.com/android/release" }
    }
}

Adicionando dependências

Para integrar o Certta SDK ao seu app, adicione as dependências necessárias ao nível do módulo (nível do app) build.gradle.kts arquivo do seu projeto.

Coloque a seguinte linha dentro do seu dependencies bloco:

build.gradle.kts

dependencies {
    // Gerencia as versões de todas as dependências
    implementation(platform("io.caf.sdk:caf-sdk-bom:7.19.0"))
    
    // --- Detector de Documentos (Escolha um) ---
    implementation("io.caf.sdk:document-detector-ui") // Adiciona telas de UI personalizáveis
    // implementation("io.caf.sdk:document-detector") // Apenas o núcleo (crie sua própria UI)

    // --- Prova de vida facial (Escolha um) ---
    implementation("io.caf.sdk:caffaceliveness-ui") // Adiciona telas de UI personalizáveis
    // implementation("io.caf.sdk:caffaceliveness") // Apenas o núcleo (crie sua própria UI)

    // --- Provedores de prova de vida ---
    implementation("io.caf.sdk:caffaceliveness-providers-iproov-lite")
    implementation("io.caf.sdk:caffaceliveness-providers-payface")
    implementation("io.caf.sdk:caffaceliveness-providers-facetec")
    
    // --- Impressão digital ---
    implementation("io.caf.sdk:fingerprint")
}

build.gradle

dependencies {
    // Gerencia as versões de todas as dependências
    implementation platform("io.caf.sdk:caf-sdk-bom:7.13.0")
    
    // --- Detector de Documentos (Escolha um) ---
    implementation "io.caf.sdk:document-detector-ui" // Adiciona telas de UI personalizáveis
    // implementation "io.caf.sdk:document-detector" // Apenas o núcleo (crie sua própria UI)

    // --- Prova de vida facial (Escolha um) ---
    implementation "io.caf.sdk:caffaceliveness-ui" // Adiciona telas de UI personalizáveis
    // implementation "io.caf.sdk:caffaceliveness" // Apenas o núcleo (crie sua própria UI)

    // --- Provedores de prova de vida ---
    implementation "io.caf.sdk:caffaceliveness-providers-iproov-lite"
    implementation "io.caf.sdk:caffaceliveness-providers-payface"
    implementation "io.caf.sdk:caffaceliveness-providers-facetec"
    
     // --- Impressão digital ---
    implementation "io.caf.sdk:fingerprint"
}

Ao usar o caffaceliveness módulo, você deve incluir pelo menos uma dependência de provedor de prova de vida (como iproov-lite, payface, ou facetec) em seu build.gradle arquivo do seu projeto.

Configuração e personalizações

Obtendo o token móvel

Para gerar seu token móvel, siga este guia:

Autenticação

Configurando a sessão

Depois de obter seu token móvel, inicialize o Certta SDK dentro da sua custom Application classe. Isso deve ser feito dentro do onCreate() método usando o contexto da aplicação e seu objeto de configuração.

Aqui está um exemplo de como sua Application classe pode ficar:

Tanto o userId e mobileToken são opcionais durante a configuração inicial. Além disso, esses valores não são permanentes; você pode atualizá-los ou alterá-los a qualquer momento durante o ciclo de vida da aplicação, conforme suas necessidades evoluírem.

MyApplication.kt

val config = CerttaConfiguration(
    userId = "user-id",
    mobileToken = "your-jwt",
    environment = CerttaEnvironment.PROD,
    securityEnabled = true,
)

Certta.instance.configure(
    context = this,
    config = config
)

MyApplication.java

CerttaConfiguration config = new CerttaConfiguration(
   "your-jwt",     // token móvel
   "user-id",      // ID do usuário
   CerttaEnvironment.PROD, // ambiente
   true,            // segurança habilitada
);

Certta.getInstance().configure(this, config);

Parâmetros de CerttaConfiguration

Parâmetro

Tipo

Descrição

mobileToken

String

Seu Token Web JSON (JWT) gerado.

userId

String

Um identificador exclusivo para o usuário.

securityEnabled

Booleano

Ativa ou desativa as validações de segurança.

environment

CerttaEnvironment

Define o ambiente de execução.

Atualizações de configuração em tempo de execução

O userId e mobileToken não ficam restritas à configuração inicial; elas podem ser atualizadas dinamicamente em tempo de execução para acomodar mudanças nas sessões dos usuários ou nos requisitos de segurança.

Esses métodos podem ser chamados de qualquer Activity ou Fragment após a configuração inicial ter sido estabelecida na sua Application classe.

Para atualizar esses valores, use os métodos específicos fornecidos pela Certta instância:

MyActivity.kt

Certta.instance.updateUserId("new-user-id")
Certta.instance.updateMobileToken("new-jwt-token")

MyActivity.java

Certta.getInstance().updateUserId("new-user-id");
Certta.getInstance().updateMobileToken("new-jwt-token");

Use esses métodos sempre que seu app realizar logout/login ou quando seu backend emitir um JWT atualizado para garantir que o Certta SDK permaneça sincronizado com sua sessão ativa.

Tematização de cores

Tanto os módulos de prova de vida quanto de Detector de Documentos suportam tematização personalizada de cores, permitindo que você combine perfeitamente a interface do SDK com as diretrizes de marca do seu aplicativo. Você pode personalizar a UI fornecendo valores de cor em um formato padrão de string hexadecimal (por exemplo, "#RRGGBB").

Após configurar o SDK, crie um CerttaColorConfiguration objeto com as cores que você deseja alterar e passe-o para Certta.instance.setColorConfiguration().

val colorConfig = CerttaColorConfiguration(
    primaryColor = "#FF0000",
    secondaryColor = "#00FF00",
    backgroundColor = "#FFFFFF",
    contentColor = "#000000",
    mediumColor = "#D1D1D1",
    dialogBackgroundColor = "#FFFFFF",
    dialogBorderColor = "#0C395E",
)
Certta.instance.setColorConfiguration(colorConfig)

CafColorConfiguration colorConfig = new CafColorConfiguration(
      "#FF0000", // primaryColor
      "#00FF00", // secondaryColor
      "#FFFFFF", // backgroundColor
      "#000000", // contentColor
      "#D1D1D1", // mediumColor,
      "#FFFFFF", // dialogBackgroundColor
      "#0C395E" // dialogBorderColor
);
Certta.getInstance().setColorConfiguration(colorConfig);

Parâmetros de ColorConfiguration

Todos os parâmetros do objeto de configuração são opcionais. Você só precisa definir as cores específicas que deseja sobrescrever para o seu tema personalizado.

Propriedade de cor

Descrição

primaryColor

Cor principal para botões e destaques.

secondaryColor

Cor secundária para elementos complementares.

backgroundColor

Cor de fundo da tela.

contentColor

Cor usada para textos e ícones.

mediumColor

Cor neutra para elementos como barras de progresso.

dialogBackgroundColor

Cor de fundo de diálogos e pop-ups.

dialogBorderColor

Cor da borda de diálogos e pop-ups.

Ofuscação de código

Confira o bloco de código com as regras do ProGuard/R8 necessárias para que o SDK e suas dependências funcionem corretamente mesmo após a ofuscação e a otimização do código. Essas regras preservam informações essenciais (como assinaturas, anotações e classes internas) e impedem que classes críticas sejam removidas ou alteradas.

proguard_rules.txt

# O pré-handler Android para exceções é carregado de forma reflexiva (via ServiceLoader).
-keep class kotlinx.coroutines.experimental.android.AndroidExceptionPreHandler { *; }

### GSON ##################################################################
# O Gson usa informações genéricas de tipo armazenadas em um arquivo de classe ao trabalhar com campos.
# O ProGuard remove essas informações por padrão, então configure-o para manter todas elas.
-keepattributes Signature
# Para usar a anotação @Expose do GSON
-keepattributes *Annotation*
### FIM GSON ##################################################################

### Retrofit ##################################################################
# Preserva assinaturas genéricas, classes internas e métodos envolventes para a reflexão do Retrofit.
-keepattributes Signature, InnerClasses, EnclosingMethod
# Mantém anotações visíveis em tempo de execução em métodos e parâmetros.
-keepattributes RuntimeVisibleAnnotations, RuntimeVisibleParameterAnnotations
# Mantém os valores padrão das anotações.
-keepattributes AnnotationDefault
# Mantém os parâmetros dos métodos de serviço para interfaces com anotações do Retrofit.
-keepclassmembers,allowshrinking,allowobfuscation interface * {
    @retrofit2.http.* <methods>;
}
# Suprime avisos para ferramentas de build e certas anotações JSR 305.
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
-dontwarn javax.annotation.**
-dontwarn kotlin.Unit
-dontwarn retrofit2.KotlinExtensions
-dontwarn retrofit2.KotlinExtensions$*
# Mantém explicitamente as interfaces do Retrofit para evitar a nulificação pelo R8.
-if interface * { @retrofit2.http.* <methods>; }
-keep,allowobfuscation interface <1>
-if interface * { @retrofit2.http.* <methods>; }
-keep,allowobfuscation interface * extends <1>
# Preserva as continuations usadas por funções suspend do Kotlin.
-keep,allowobfuscation,allowshrinking class kotlin.coroutines.Continuation
# Para o modo completo do R8: mantém os tipos genéricos de retorno para métodos do Retrofit.
-if interface * { @retrofit2.http.* public *** *(...); }
-keep,allowoptimization,allowshrinking,allowobfuscation class <3>
# Preserva a classe Response do Retrofit.
-keep,allowobfuscation,allowshrinking class retrofit2.Response
### FIM Retrofit ##############################################################

### OkHttp ####################################################################
# Suprime avisos para anotações JSR 305.
-dontwarn javax.annotation.**
# Adapta os nomes de arquivos de recursos para o banco de dados interno de sufixos públicos.
-adaptresourcefilenames okhttp3/internal/publicsuffix/PublicSuffixDatabase.gz
# Suprime avisos para o Animal Sniffer e classes específicas da plataforma.
-dontwarn org.codehaus.mojo.animal_sniffer.*
-dontwarn okhttp3.internal.platform.**
-dontwarn org.conscrypt.**
-dontwarn org.bouncycastle.**
-dontwarn org.openjsse.**
# Mantém todas as classes do OkHttp e do Okio.
-keep class okhttp3.** { *; }
-dontwarn okhttp3.**
-keep class okio.** { *; }
-dontwarn okio.**
-dontwarn javax.annotation.Nullable
-dontwarn javax.annotation.ParametersAreNonnullByDefault
### FIM OkHttp ################################################################

### Serialização Kotlin ######################################################
# Mantém os objetos Companion para classes serializáveis.
-if @kotlinx.serialization.Serializable class **
-keepclassmembers class <1> {
    static <1>$Companion Companion;
}
# Mantém funções serializer nos objetos companion.
-if @kotlinx.serialization.Serializable class ** {
    static **$* *;
}
-keepclassmembers class <2>$<3> {
    kotlinx.serialization.KSerializer serializer(...);
}
# Mantém INSTANCE e serializer para objetos serializáveis.
-if @kotlinx.serialization.Serializable class ** {
    public static ** INSTANCE;
}
-keepclassmembers class <1> {
    public static <1> INSTANCE;
    kotlinx.serialization.KSerializer serializer(...);
}
# Preserva objetos Companion em kotlinx.serialization.json.
-keepclassmembers class kotlinx.serialization.json.** {
    *** Companion;
}
-keepclasseswithmembers class kotlinx.serialization.json.** {
    kotlinx.serialization.KSerializer serializer(...);
}
# Preserva a busca do serializer para classes serializáveis (ajuste o nome do pacote conforme necessário).
-keepclassmembers @kotlinx.serialization.Serializable class packeage.** {
    *** Companion;
    *** INSTANCE;
    kotlinx.serialization.KSerializer serializer(...);
}
### FIM Serialização Kotlin #################################################

### AutoValue ################################################################
-dontwarn com.google.auto.**
-dontwarn autovalue.shaded.com.**
-dontwarn sun.misc.Unsafe
-dontwarn javax.lang.model.element.Modifier
### FIM AutoValue ############################################################

### CAF - Combate à Fraude ######################################################
# Mantém atributos de exceções.
-keepattributes Exceptions
# Preserva todas as classes, interfaces e membros de classe para os módulos CAF.
-keep class com.caf.facelivenessiproov.** { *; }
-keep class com.combateafraude.documentdetector.** { *; }
-keep class com.combateafraude.** { *; }
-keep interface com.combateafraude.** { *; }
-keep class io.caf.** { *; }
-keep interface io.caf.** { *; }
-keepclassmembers class com.combateafraude.** { *; }
# Suprime avisos para java.nio.file e certas classes internas do OkHttp.
-dontwarn java.nio.file.*
-dontwarn com.squareup.okhttp.internal.Platform
# Mantém campos em classes que estendem GeneratedMessageLite (para uso com Tink).
-keepclassmembers class * extends com.google.crypto.tink.shaded.protobuf.GeneratedMessageLite {
  <fields>;
}
# Preserva classes do TensorFlow.
-keep class org.tensorflow.** { *; }
-keep class org.tensorflow.**$* { *; }
-dontwarn org.tensorflow.**
# Preserva classes do IProov e classes do Protobuf.
-keep public class com.iproov.sdk.IProov { public *; }
-keep class com.iproov.** { *; }
-keep class com.iproov.**$* { *; }
-keep class com.google.protobuf.** { *; }
-keep class com.google.protobuf.**$* { *; }
-dontwarn com.google.protobuf.**
# Suprime avisos para classes Flow concorrentes.
-dontwarn java.util.concurrent.Flow*
# Preserva classes Kotlin e kotlinx.
-keep class kotlin.** { *; }
-keep class kotlinx.** { *; }
-dontwarn com.android.tools.lint.**
-dontwarn io.caf.sdk.common.jvmshared.lint.**
### FIM CAF - Combate à Fraude ##################################################

Atualizado há 1 mês