Liveness 3D - Tema Interativo

Plataforma interativa de customizações da chave theme para React Native

1. Guia Rápido

O Tema Interativo para personalização da biblioteca do Liveness 3D é uma plataforma essencial que permite a seleção de cores, bordas, arredondamento de bordas e sombreamento. Isso simplifica a geração de código, possibilitando a fácil implementação no seu Liveness 3D.

Aprenda a personalizar o Liveness 3D no React Native para integrar as propriedades customizadas em seu código de forma simples e ágil.

Siga os passos para interagir com o Tema Interativo.

Antes de começar

  • Será necessário importar as fontes desejadas para a pasta de fontes do seu ambiente Android e iOS, nativamente arrastando e soltando seus arquivos .tff na pasta "assets res/fonts.xml" no Android, e no iOS registrando nos assets da aplicação.

Telas para customização

O Tema Interativo apresenta três telas de customização que orientam o usuário durante a execução do Liveness 3D:

  • Na primeira tela, encontramos as instruções para a preparação do usuário, sendo o ponto inicial de interação com o Liveness 3D.
  • A segunda tela é destinada à retentativa. Caso o usuário precise refazer a jornada, essa tela fornece diretrizes, incluindo um exemplo de foto ideal.
  • A terceira tela consiste na tela de resultado. Nela, o usuário recebe a mensagem de conclusão do processo de Liveness.
Sequência de telas exibidas no iframe para customização.

Propriedades customizáveis

As propriedades destinadas à customização estão localizadas na segunda coluna do iframe. Nesta coluna, é possível encontrar o nome da propriedade (1) e sua respectiva descrição (2).

Coluna de propriedades customizáveis.

Para exportar o código das customizações

Passo 1: visualize o código

Após concluir todas as personalizações, é necessário clicar no botão "código" (1) para visualizar todas as modificações realizadas e, em seguida, exportá-las para incorporação no seu projeto.

Localização do botão "código" para exportação das customizações.

Passo 2: importe as fontes

Coloque os arquivos de fontes na pasta "assets res/fonts.xml" no Android ou registre nos assets caso seja iOS.

Passo 3: inicie o objeto de theme

Utilize o exemplo a seguir para iniciar o theme do tema com as propriedades desejadas.

{
  appkey: "",
  ticket: "",
  environment: "HML",
   // THEME AQUI
  theme: {
    guidanceCustomizationHeaderFont: "#000000"
  },
   // FONTS AQUI
  fonts: {
  	guidanceCustomizationButtonFont: 'lobster',
  },
  liveness3Dtext: {
    READY_HEADER_1: "Prepare-se para seu",
    READY_HEADER_2: "reconhecimento facial."
  }
}

Passo 4: identifique e implemente as propriedades

O objeto de cores inclui uma série de propriedades que podem ser customizadas, divididas em categorias como Guidance, Botões, Ready e Retry Screen, entre outras.

O código das propriedades customizadas também reflete essa série mencionada anteriormente. Identifique e implemente de acordo com as respectivas customizações.


2. Tema Interativo - RN

Use a plataforma para iniciar as customizações do Liveness 3D.

Customizar Liveness 3D


3. Propriedades customizáveis

Abaixo, estão mapeadas as propriedades para customização do objeto JSON theme.

Customizações de telas Liveness3D

Guidance

AtributoTipoDescrição
guidanceCustomizationForegroundColornumber?Modifica a cor de fundo quando estiver em primeiro plano.

Botões

AtributoTipoDescrição
guidanceCustomizationButtonTextNormalColorstring?Modifica a cor do texto do botão na sua condição padrão.
guidanceCustomizationButtonBackgroundNormalColorstring?Modifica a cor de fundo do botão na sua condição padrão.
guidanceCustomizationButtonTextHighlightColorstring?Modifica a cor do texto do botão na sua condição de destaque.
guidanceCustomizationButtonBackgroundHighlightColorstring?Modifica a cor de fundo do botão na sua condição de destaque.
guidanceCustomizationButtonTextDisabledColorstring?Modifica a cor do texto do botão na sua condição de desabilitado.
guidanceCustomizationButtonBackgroundDisabledColorstring?Modifica a cor de fundo do botão na sua condição de desabilitado.
guidanceCustomizationButtonBorderColorstring?Modifica a cor da borda do botão.
guidanceCustomizationButtonBorderWidthnumber?Modifica a largura da borda do botão.
guidanceCustomizationButtonCornerRadiusnumber?Modifica o tamanho do arredondamento das bordas do botão.

Ready Screen

AtributoTipoDescrição
guidanceCustomizationReadyScreenHeaderTextColorstring?Modifica a cor da fonte do texto.
guidanceCustomizationReadyScreenHeaderAttributedStringstring?Adiciona um texto para o header.
guidanceCustomizationReadyScreenSubtextTextColorstring?Modifica a cor da fonte do texto.
guidanceCustomizationReadyScreenSubtextAttributedStringstring?Adiciona um texto para o subtext.
guidanceCustomizationReadyScreenOvarFillColorstring?***
guidanceCustomizationReadyScreenTextBackgroundColorstring?Modifica a cor de fundo.
guidanceCustomizationReadyScreenTextBackgroundCornerRadiusnumber?Modifica o tamanho do arredondamento das bordas.

Retry Screen

AtributoTipoDescrição
guidanceCustomizationRetryScreenHeaderTextColornumber?Modifica a cor da fonte do header.
guidanceCustomizationRetryScreenHeaderAttributedStringstringAdiciona uma mensagem personalizada no header.
guidanceCustomizationRetryScreenSubtextTextColorstring?Modifica a cor da fonte do subtext.
guidanceCustomizationRetryScreenSubtextAttributedStringstring?Adiciona uma mensagem personalizada no subtext.
guidanceCustomizationRetryScreenImageBorderColorstring?Modifica a cor da borda do preview da imagem de retentativa.
guidanceCustomizationRetryScreenImageBorderWidthnumber?Modifica a largura da borda do preview da imagem de retentativa.
guidanceCustomizationRetryScreenImageCornerRadiusnumber?Modifica o tamanho do arredondamento das bordas.
guidanceCustomizationRetryScreenOvarStrokeColorstring?Modifica a cor da borda do preview oval da imagem de retentativa.

Result Screen Customization

AtributoTipoDescrição
resultScreenCustomizationForegroundColorstringModifica a cor de fundo quando estiver em primeiro plano.
resultScreenCustomizationBackgroundColorsstringModifica a cor de fundo e caso receba duas cores diferentes cria um degradê.
resultScreenCustomizationActivityIndicatorColorstringModifica a cor do activity indicator.
resultScreenCustomizationCustomActivityIndicatorImagestringAdiciona uma imagem customizada para o activity indicator.
resultScreenCustomizationCustomActivityIndicatorRotationIntervarstring
resultScreenCustomizationShowUploadProgressBarstringPropriedade booleana que ativa a visualização da barra de progresso.
resultScreenCustomizationUploadProgressFillColorstringModifica a cor do preenchimento da barra de progresso.
resultScreenCustomizationUploadProgressTrackColorstringModifica a cor da barra de progresso.
resultScreenCustomizationResultAnimationBackgroundColorstringModifica a cor de fundo da imagem que aparece após a animação finalizar.
resultScreenCustomizationResultAnimationForegroundColorstringModifica a cor do icone que vai aparecer em primeiro plano após a animação finalizar.

Oval Customization

AtributoTipoDescrição
ovarCustomizationStrokeWidthnumber?Modifica a largura da borda da camada oval.
ovarCustomizationStrokeColorstring?Modifica a cor da borda da camada oval.
ovarCustomizationProgressStrokeWidthnumber?Modifica a largura da borda do progresso da camada oval.
ovarCustomizationProgressColor1string?Modifica a cor da borda de progresso da camada oval.
ovarCustomizationProgressColor2IntstringModifica a cor da borda de progresso da camada oval.
ovarCustomizationProgressRadialOffsetnumber?Modifica o distânciamento da borda de progresso da camada oval.

Frame Customization

AtributoTipoDescrição
frameCustomizationBorderWidthnumber?Modifica a largura da borda do frame.
frameCustomizationCornerRadiusnumber?Modifica o tamanho do arredondamento das bordas do frame.
frameCustomizationBorderColorstring?Modifica a cor da borda do frame.
frameCustomizationBackgroundColorstring?Modifica a cor de fundo do frame.
frameCustomizationElevationnumber?Sombra do frame.

Overlay Customization

AtributoTipoDescrição
overlayCustomizationBackgroundColorstring?Modifica a cor de fundo da camada de overlay.
overlayCustomizationBrandingImagestring?Adiciona uma imagem na camada de overlay.

Feedback Customization

AtributoTipoDescrição
feedbackCustomizationCornerRadiusnumber?Modifica o tamanho do arredondamento das bordas da barra.
feedbackCustomizationBackgroundColorstring?Modifica a cor de fundo da barra.
feedbackCustomizationTextColorstring?Modifica a cor do texto do feedback.

Cancel Button

AtributoTipoDescrição
cancelButtonCustomizationCustomImagestringCancela a operação e retorna para view anterior.
cancelButtonCustomizationLocationstringEnum que determina a posição do botão. Esquerda, deireita ou desabilitado.

Customização dos Textos

Da mesma forma que criamos um objeto dento do options, criamos para as fontes no 3D, seguindo esse exemplo:

{
  appkey: "",
  ticket: "",
  environment: "HML",
  theme: {
    guidanceCustomizationHeaderFont: "#000000"
  },
  //TEXTOS AQUI
  liveness3Dtext: {
    READY_HEADER_1: "Prepare-se para seu",
    READY_HEADER_2: "reconhecimento facial."
  }
}

Ready Screen

Novo identificadorAntiga tag do arquivo XML
READY_HEADER_1FaceTec_instructions_header_ready_1
READY_HEADER_2FaceTec_instructions_header_ready_2
READY_MESSAGE_1FaceTec_instructions_message_ready_1
READY_MESSAGE_2FaceTec_instructions_message_ready_2
READY_BUTTONFaceTec_action_im_ready

Retry Screen

Novo identificadorAntiga tag do arquivo XML
RETRY_HEADERFaceTec_retry_header
RETRY_SUBHEADERFaceTec_retry_subheader_message
RETRY_MESSAGE_SMILEFaceTec_retry_instruction_message_1
RETRY_MESSAGE_LIGHTINGFaceTec_retry_instruction_message_2
RETRY_MESSAGE_CONTRASTFaceTec_retry_instruction_message_3
RETRY_YOUR_PICTUREFaceTec_retry_your_image_label
RETRY_IDEAL_PICTUREFaceTec_retry_ideal_image_label
RETRY_BUTTONFaceTec_action_try_again

Result Screen

Novo identificadorAntiga tag do arquivo XML
RESULT_UPLOAD_MESSAGEFaceTec_result_facescan_upload_message
RESULT_SUCCESS_MESSAGEFaceTec_result_success_message

Feedback

Novo identificadorAntiga tag do arquivo XML
FEEDBACK_CENTER_FACEFaceTec_feedback_center_face
FEEDBACK_FACE_NOT_FOUNDFaceTec_feedback_face_not_found
FEEDBACK_FACE_NOT_LOOKING_STRAIGHT_AHEADFaceTec_feedback_face_not_looking_straight_ahead
FEEDBACK_FACE_NOT_UPRIGHTFaceTec_feedback_face_not_upright
FEEDBACK_HOLD_STEADYFaceTec_feedback_hold_steady
FEEDBACK_MOVE_PHONE_AWAYFaceTec_feedback_move_phone_away
FEEDBACK_MOVE_PHONE_CLOSERFaceTec_feedback_move_phone_closer
FEEDBACK_MOVE_PHONE_TO_EYE_LEVELFaceTec_feedback_move_phone_to_eye_level
FEEDBACK_USE_EVEN_LIGHTINGFaceTec_feedback_use_even_lighting
FEEDBACK_FRAME_YOUR_FACEFaceTec_presession_frame_your_face
FEEDBACK_LOOK_STRAIGHT_IN_OVALFaceTec_presession_position_face_straight_in_oval
FEEDBACK_HOLD_STEADY_1FaceTec_presession_hold_steady_1
FEEDBACK_HOLD_STEADY_2FaceTec_presession_hold_steady_2
FEEDBACK_HOLD_STEADY_3FaceTec_presession_hold_steady_3
FEEDBACK_REMOVE_DARK_GLASSESFaceTec_presession_remove_dark_glasses
FEEDBACK_NEUTRAL_EXPRESSIONFaceTec_presession_neutral_expression
FEEDBACK_EYES_STRAIGHT_AHEADFaceTec_presession_eyes_straight_ahead
FEEDBACK_CONDITIONS_TOO_BRIGHTFaceTec_presession_conditions_too_bright
FEEDBACK_BRIGHTEN_YOUR_ENVIRONMENTFaceTec_presession_brighten_your_environment