HomeGuia de ProdutoCertiface APIReleases
Guia de Produto

Guia Rápido de Uso

Siga os passos abaixo para integrar o SDK no seu app Android

Guia rápido de uso - Certiface Doc SDK (Android)

⚙️Configuração mínima

Configuração mínima para o SDK funcionar no seu app.

🔄 Migração (versões antigas)

Migração a partir do Doc Core (Intent / activity antiga): A integração atual é diferente. Para comparação com o modelo anterior, utilize o Doc Core Android apenas como referência. Mais detalhes estão no guia detalhado .

📚Conteúdo avançado

Tudo que não for essencial aqui como customização de telas, imagens de referência, fontes e boas práticas está no Guia detalhado de uso .

🧪 Projeto de exemplo

Prefere começar com algo já funcional? Acesse o projeto demo oficial: oititec/certiface-sdk-demo.

⚙️Instalação

No settings.gradle.kts (ou settings.gradle):

dependencyResolutionManagement {
    repositories {
        // ...
        maven("https://raw.githubusercontent.com/oititec/certiface-doc-versions/main")
    }
}

No módulo do aplicativo (build.gradle.kts):

dependencies {
    implementation("br.com.certiface.doc:manager:1.0.0")
}

Substitua 1.0.0 pela versão publicada. Essa dependência resolve o SDK completo por dependências transitivas.

🚀Inicialização e configuração

A AppKey é do seu produto/backend; o app só repassa ao SDK.

import br.com.certiface.doc.manager.exports.createSDKConfig
import br.com.certiface.doc.manager.exports.Environment
import br.com.certiface.doc.manager.main.CertifaceDocSDK

val config = createSDKConfig(
    appKey = appKey,
    environment = Environment.HML, // homologação; em produção use Environment.PRD
    theme = null,
    enableCnhDigital = true,
    enablePdfUpload = true
)

val documentManager = CertifaceDocSDK.initialize(context, config)

🧪 Execução do fluxo

import br.com.certiface.doc.manager.exports.ResultCallback
import br.com.certiface.doc.domain.models.CertifaceDocResponse
import br.com.certiface.doc.domain.models.CertifaceDocResult

documentManager.start(
    config,
    object : ResultCallback<CertifaceDocResult> {
        override fun onSuccess(result: CertifaceDocResponse) {
            val doc = result.docResult
            // Sucesso
        }

        override fun onError(result: CertifaceDocResponse) {
            val message = result.errorResponse?.errorMessage
            // Erro ou cancelamento
        }
    }
)

🧪 Ambiente de testes

  • Use Environment.HML e AppKey de homologação.
  • Só use Environment.PRD com AppKey de produção após validar o fluxo.

📋 Checklist

  • minSdk 26 · AndroidX · Jetpack Compose alinhado ao SDK
  • Kotlin 2.0.x · Java 17
  • Repositório Maven e br.com.certiface:manager
  • Callbacks onSuccess / onError tratados

✅Próximo passo

Updated 25 days ago