For the complete documentation index, see llms.txt. This page is also available as Markdown.

Lançamento simplificado

Esta seção mostra exemplos práticos para integrar e utilizar o SDK da Facephi em aplicativos móveis Android, adaptados aos fluxos de verificação mais comuns.

Inicializar o SDK

O SDK funciona por meio de um controlador principal (SDKController). A Facephi fornecerá o apiKey da licença necessário para a inicialização.

val sdkConfig = SdkConfigurationData(
    sdkApplication = SdkApplication(application),
    licensing = LicensingOnline(EnvironmentLicensingData(
            apiKey = "...")
      )),
)

val result = SDKController.initSdk(sdkConfig)

when (result) {
  is SdkResult.Success -> Log.d("APP: INIT SDK: OK")
  is SdkResult.Error -> Log.d(
          "APP: INIT SDK: KO - ${result.error.name}"
        )
}

if (BuildConfig.DEBUG) {
    SDKController.enableDebugMode()
}

Iniciar operação

Antes de lançar qualquer componente, é obrigatório iniciar uma operação.

Este método tem os seguintes parâmetros de entrada:

  1. operationType: Indica se será feito um processo de ONBOARDING ou de AUTHENTICATION.

  2. customerId: Identificador do usuário (controlado no nível da aplicação).

  3. steps: Lista de etapas da operação se tiverem sido definidas previamente.

  4. enableTracking: Indica se a operação deve enviar eventos de Tracking. Por padrão é true.

Quando a operação é criada corretamente, result.data contém um OperationResult com sessionId, operationId, type e customerId. Esses valores identificam a sessão e a operação ativa, e podem ser usados para rastreabilidade ou para vincular chamadas posteriores à plataforma.

Se a criação de uma nova operação devolver um erro do tipo INTERNAL_ERROR isso se deve principalmente a um problema de segurança. Para investigar a causa, é possível recuperar o Token associado ao erro, o qual fornece informações adicionais para sua análise.

Lançamento de componentes

Cada componente tem seu próprio controlador e é iniciado a partir de SDKController.

O resultado de launch mantém a estrutura comum SdkResult: em Success, data contém a saída própria do componente iniciado; em Erro, error contém o erro específico do componente ou do SDK.


Segurança

O SDK de Android incorpora um sistema de segurança destinado a detectar e bloquear ambientes potencialmente pouco confiáveis ou que possam indicar tentativas de ataque.

Este mecanismo está habilitado por padrão, permite identificar situações que poderiam comprometer a segurança e evita a execução do SDK em contextos que não são considerados seguros:


Atualizado