O SDK Web permite que algumas personalizações sejam feitas. Abaixo veja todas as personalizações possíveis para este SDK.

Personalizar idioma

É possível configurar a experiência das mensagens informativas dos frames de captura alterando seu idioma. Utilize o enumerado LocaleTypes que contém os seguintes valores:

• LocaleTypes.PT_BR: para Português(Brasil);

• LocaleTypes.ES_MX: para Espanhol(México);

• LocaleTypes.ES_ES: para Espanhol(Espanha);

• LocaleTypes.EN_US: para Inglês(EUA).

Veja como implementar no exemplo abaixo:

import {
  ...
  UnicoCheckBuilder,
  LocaleTypes
  ...
} from "unico-webframe"

unicoCameraBuilder.setLocale(LocaleTypes.EN_US);

Personalizar experiência do processo de captura

Esta é uma etapa opcional, porém muito recomendada para que o processo de captura tenha a identidade visual da sua empresa.

Para efetuar a customização do frame de captura por meio do Theme Builder basta gerar uma instância da classe UnicoThemeBuilder e invocar os métodos que customizam cada uma das propriedades do frame de captura, como exemplificados a seguir:

const unicoTheme = new UnicoThemeBuilder()
.setColorSilhouetteSuccess("#0384fc")
.setColorSilhouetteError("#D50000")
.setColorSilhouetteNeutral("#fcfcfc")
.setBackgroundColor("#dff1f5")
.setColorText("#0384fc")
.setBackgroundColorComponents("#0384fc")
.setColorTextComponents("#dff1f5")
.setBackgroundColorButtons("#0384fc")
.setColorTextButtons("#dff1f5")
.setBackgroundColorBoxMessage("#fff")
.setColorTextBoxMessage("#000")
.setColorCancelButton("#0384fc")
.setColorProgressBar("#0384fc")
.setHtmlPopupLoading(`<div style="position: absolute; top: 45%; right: 50%; transform:
translate(50%, -50%); z-index: 10; text-align: center;">Carregando...</div>`)
.build();

Após a geração do objeto de tema, conforme exemplificado acima, ele dever ser passado como parâmetro para o método setTheme do builder unicoCameraBuilder

unicoCameraBuilder.setTheme(unicoTheme);

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Versão 3.18.89 - 18/11/2024

• Atualização do SDK e server do Liveness com interação.

Versão 3.18.8​ - 24/10/2024

• Atualização do SDK e server do Liveness com interação;

• Resolução de conflitos entre ferramentas de observabilidade.

Versão 3.18.7​ - 15/10/2024

• Atualização do SDK e server do Liveness com interação;

• Correção de estilização em modo de captura em baixa luminosidade;

Versão 3.18.6​ - 26/09/2024

• Atualização do SDK e server do Liveness com interação.

Versão 3.18.5​ - 11/09/2024

• Atualização do SDK e server do Liveness com interação.

Versão 3.18.4​ - 02/09/2024

• Atualização do SDK e server do Liveness com interação.

Versão 3.18.3​ - 22/08/2024

• Melhorias internas de produto. Essas melhorias não afetam diretamente a experiência do usuário final, mantendo a interface e funcionalidades externas inalteradas.

Versão 3.18.2​ - 06/08/2024

• Melhorias internas de produto. Essas melhorias não afetam diretamente a experiência do usuário final, mantendo a interface e funcionalidades externas inalteradas.

Versão 3.18.1​ - 31/07/2024

• Melhoria no carregamento dos scripts do Liveness Interativo.

Versão 3.18.0​ - 25/07/2024

• Atualização do SDK e server do Liveness com interação;

• Novo modelo de implementação dos recursos do Liveness Interativo.

Versão 3.17.0​ - 04/07/2024

• Melhorias internas de produto. Essas melhorias não afetam diretamente a experiência do usuário final, mantendo a interface e funcionalidades externas inalteradas.

Versão 3.16.4​ - 29/06/2024

• Atualização do SDK e server do Smartlive com interação;

• Melhorias nas verificações de injeção de vídeo recentemente adicionadas no lado do dispositivo e no lado do servidor para mitigar ameaças de IA generativa.

Versão 3.16.3​ - 04/06/2024

• Atualização do SDK e server do Smartlive com interação;

• Melhorias nas verificações de injeção de vídeo recentemente adicionadas no lado do dispositivo e no lado do servidor para mitigar ameaças de IA generativa.

Versão 3.16.2​ - 30/05/2024

• Atualização do SDK e server do Smartlive com interação;

• Melhorias nas verificações de injeção de vídeo recentemente adicionadas no lado do dispositivo e no lado do servidor para mitigar ameaças de IA generativa.

Versão 3.16.1​ - 02/05/2024

• Melhorias internas de produto que melhoram nossa capacidade de detecção de erros.

Versão 3.16.0​ - 22/04/2024

• Novas funcionalidades que melhoram a experiência de captura no Liveness Interativo.

Versão 3.15.1​ - 09/04/2024

• Melhorias internas de produto. Essas melhorias não afetam diretamente a experiência do usuário final, mantendo a interface e funcionalidades externas inalteradas.

Versão 3.15.0​ - 25/03/2024

• Melhorias internas de produto. Essas melhorias não afetam diretamente a experiência do usuário final, mantendo a interface e funcionalidades externas inalteradas.

Versão 3.14.1​ - 14/03/2024

• Atualização do SDK e server do Smartlive com interação;

• Ajuste de tamanho de frames de CNH frente e verso em iPhones com telas de 6 polegadas ou mais.

Versão 3.14.0 - 05/03/2024

• Implementação de suporte ao uso de iFrames no Liveness Interativo.

Versão 3.13.1​ - 28/02/2024

• Melhoria internas no produto, sem impacto externo.

Versão 3.13.0​ - 22/02/2024

• Habilitamos a customização das cores do botão de cancelar e barra de progresso através dos métodos opcionais setColorCancelButton() e setColorProgressBar();

• Habilitamos a customização dos textos da UI do liveness interativo via configuração remota.

Versão 3.12.1​ - 07/02/2024

• Nova personalização de logomarca no modo de captura do Liveness Ativo. Em breve adicionaremos mais informações na documentação;

• Adição de novos tratamentos do Liveness Ativo durante o prepareCamera.

  • Lançar erro 73402 caso haja falha no carregamento do frame devido a problemas de rede;

  • Lançar erro 73403 caso o dispositivo/browser não seja suportado pelo SDK;

  • Lançar erro 73404 caso o dispositivo esteja em modo de tela paisagem;

  • Lançar erro 73405 caso o dispositivo esteja bloqueado por segurança devido a muitas tentativas mal sucedidas;

  • Lançar erro 73406 caso o SDK seja executado em um iFrame;

  • Lançar erro 73407 caso o SDK não tenha carregado todos os recursos completamente;

  • Lançar erro 73600 caso haja erro no carregamento dos recursos do Liveness Ativo.

• Melhorias nas regras de compatibilidade do SDK com o Angular 10.

Versão 3.11.1​ - 22/01/2024

• Atualização do SDK e server do Smartlive com interação.

Versão 3.11.0​ - 16/01/2024

• Novas funcionalidades de autenticação e captura, disponíveis mediante análise interna pela equipe Unico para garantir segurança eficaz.

• Adição de novos tratamentos de erros do Liveness Ativo:

  • Erro 73728 em caso de abertura do SDK em domínios sem HTTPS;

  • Erro 73729 em caso de abertura do SDK em browsers incompatíveis;

  • Erro 73730 um erro interno de licença;

  • Erro 73731 um erro interno de licença expirada;

  • Erro 73732 em caso de abertura do SDK em uma origem não configurada.

Versão 3.10.6​ - 11/01/2024

• Atualização no modulo de segurança da SDK;

• Melhoria internas no produto, sem impacto externo.

Versão 3.10.5​ - 15/12/2023

• Melhoria no fluxo de autenticação, reduzindo falhas na autenticação de dispositivos com configurações específicas no Sistema Operacional.

Versão 3.10.4​ - 12/12/2023

• Definição automática de ambientes de produção e homologação no SDK.

Versão 3.10.3​ - 04/12/2023

• Melhorias internas do produto.

Versão 3.10.2​ - 28/11/2023

• Atualização do SDK e server do Smartlive com interação.

Versão 3.10.1​ - 14/11/2023

• Atualização do SDK e server do Smartlive com interação;

• Atualização de segurança na lib crypto-es para a versão 2.1.0.

Versão 3.10.0​ - 16/10/2023

• Disponibilizar o novo fluxo de captura e retentativas quando usado o Liveness com Interação (entrar em contato com a Unico caso queira habilitar essa nova funcionalidade);

• Lançar erro 73800 caso haja falha na captura usando o fluxo de retentativa;

• Lançar erro 73100 caso haja falha de conexão com internet durante uma requisição.

Versão 3.9.4​ -12/09/2023

• Correção no download do SDK via NPM.

Versão 3.9.3​ - 05/09/2023

• Recomendamos atualizar! Correção e normalização das chaves de rastreabilidade da sessão de captura a qual nos permite ter uma analise anti-fraude mais sólida de ponta-a-ponta.

• Melhorias internas do produto.

Versão 3.9.2​ - 18/08/2023

• Melhorias internas do produto.

Versão 3.9.1​ - 30/07/2023

• Atualização do SDK e server do Smartlive com interação;

• Melhorias internas do produto;

• Correção em frases da tela de retry em Inglês e Espanhol;

• Correção do frame de documento others no desktop.

Versão 3.9.0​ - 18/07/2023

• Atualização do SDK e server do Smartlive com interação;

• Implementação de experiência de captura de selfie nos idiomas Inglês e Espanhol;

• Correção em exceção lançada quando não há permissão de acesso a geolocalização;

• Correção na abertura da câmera de documentos.

Versão 3.8.3​ - 20/06/2023

• Atualização do SDK e server do Smartlive com interação;

• Atualização de mensagem no final do fluxo de captura com Smartlive Interativo.

Versão 3.8.2​ - 17/05/2023

• Atualização do SDK e server do Smartlive com interação;

• Revisão dos textos de orientação ao usuário na captura biométrica.

Versão 3.8.1​ - 28/04/2023

• Melhoria internas no produto, sem impacto externo.

Versão 3.8.0​ - 24/04/2023

• Atualização do SDK e server do Smartlive com interação;

• Melhoria em captura com Smartlive com interação no Samsung Internet Browser;

• Possibilidade de utilizar ambientes de Uat ou Prod na mesma versão do SDK.

Versão 3.7.2​ - 31/03/2023

• Melhoria de segurança na comunicação da SDK.

Versão 3.7.1​ - 28/03/2023

• Atualização do SDK e server do Smartlive com interação.

Versão 3.7.0​ - 15/02/2023

• Adição de nova forma de configuração que permite inserir as configurações do SDK pela classe UnicoConfig;

• Hot fix: Correção em tratamento anti-injection para conflitos com o Sentry.

Versão 3.6.5​ - 03/02/2023

• Atualização do SDK e server do Smartlive com interação;

• Melhoria em tratamento anti-injection;

• Melhoria na compatibilidade do SDK com frameworks mais antigos.

Versão 3.6.4​ - 06/01/2023

• Hot fix: Correção em tratamento anti-injection para Motorola Edge;

• Hot fix: Correção em validação de evento para browser Safari.

Versão 3.6.3​ - 26/12/2022

• Melhorias de segurança voltadas a anti-injection;

• Atualização da versão do SDK e Server do Smartlive com interação;

• Correção em fechamento de câmera nos frames sem interação.

Versão 3.6.2​ - 07/12/2022

• Suporte ao navegador Samsung internet;

• Coleta de dados de uso, geolocalização e dispositivo (os dados coletados são usados para garantir a segurança do processo e melhorar a experiência do usuário).

Versão 3.6.1​ - 17/11/2022

• Melhorias em tratamentos anti-injection;

• Customização automática dos modos de alta e baixa luminosidade do Smartlive com interação;

• Atualização da versão do SDK e Server do Smartlive com interação.

Versão 3.6.0​ - 03/11/2022

• Implementação do cancelButton no Smartlive sem interação;

• Adição do modo de Câmera Traseira ao Smartlive sem interação;

• Adição de opacidade em botão principal do Smartlive com interação em caso de rosto desalinhado.

Versão 3.5.4​ - 19/09/2022

• Atualização da versão do SDK do Smartlive com interação;

• A partir dessa versão o SDK web conta com uma das ferramentas de ofuscação de código mais poderosas do mercado.

Versão 3.5.3​ - 23/08/2022

• Compatibilidade dos frames das câmeras normal e inteligente ao uso de webview no instagram e facebook;

• Atualização da versão do SDK do Smartlive com interação;

• Hot fix: Correção na abertura do frame da câmera normal e da câmera inteligente.

Versão 3.5.2​ - 25/07/2022

• Implementação do cancelButton do Smartlive com interação;

• Hot fix: Retorno de erros de browsers não suportados;

• Hot fix: Remoção do frame do Smartlive com interação após erro.

Versão 3.5.1​ - 28/06/2022

• Hot fix: Correção da câmera invocada para captura de documentos em devices que possuem múltiplas câmeras

Versão 3.5.0​ - 17/06/2022

• Atualização da versão do SDK do Smartlive.

Versão 3.4.3​ - 18/04/2022

• Correção no frame de captura de CNH Aberta em desktop

Versão 3.4.2​ - 12/04/2022

• Melhoria na qualidade da imagem retornada no base64;

• Melhoria em requests de autenticação;

• Correção para uso de WebCam na câmera de documentos.

Versão 3.4.1​ - 04/04/2022

• Melhoria em tratamento anti-injection.

Versão 3.4.0​ - 04/04/2022

• Lançamento de frames de captura de documentos com CNH frente e CNH verso;

• Captura de documentos em modo paisagem no desktop.

Versão 3.3.1​ - 22/03/2022

• Ajuste para utilização de função ao invés de classes;

• Ajuste na inicialização da camera após a segunda abertura.

Versão 3.3.0​ - 10/03/2022

• Ajuste na abertura da camera para Motorola Edge 20;

• Ajuste nas informações criptografadas retornadas para o cliente.

Versão 3.2.2​ - 18/02/2022

• Ajuste no fechamento da camera da FaceTec quando um erro é retornado.

Versão 3.2.1​ - 17/02/2022

• Remoção da tela de permissão de camera da FaceTec.

Versão 3.1.0​ - 31/01/2022

• Feature Flag para exibição do logo da unico.

Versão 3.0.1​ - 25/01/2022

• Remoção do logo da unico.

Versão 3.0.0​ - 24/01/2022

• Inclusão da funcionalidade de captura com liveness com interação.

Versão 2.0.3​

• Correção em um bug nas implementações em Angular > 6. Este bug deixava a tela congelada quando houvesse concorrência entre setTimeout's no SDK e a aplicação do cliente."

Versão 2.0.2​

• Remoção dos seguintes tipos de documentos utilizados no método initDocument():

  • 2: RG frente e verso;

  • 4: Novo RG frente e verso.

  Caso esteja utilizando os tipos mencionados acima (2 ou 4), realize a captura simples de cada documento através dos tipos:

  • 6: RG frente;

  • 7: RG verso;

  • 8: Novo RG frente;

  • 9: Novo RG verso.

• Melhorias nos retornos callback de on.error e on.support;

• Melhoria na mudança de orientação do celular;

  • Remoção da propriedade: boxOrientationHtml.

  • Caso a orientação mude, fechamos a câmera e retornamos no callback de erro;

• Maior segurança no SDK;

• Melhoria no objeto de retorno no método on.success, adicionando a propriedade encrypted que possui um JWT que deve ser enviado em menos de 10 minutos para integração com Unico check onboarding:

  Copiar

  {
      base64: string,
      encrypted: string
  }

• Mudança no suporte a browsers.

Versão 1.0.0​

Depreciações:

• Remoção da lib js antiga e tornando esta a oficial.

Versão 0.0.6​

• Correção de silhueta grande em PWA.

Versão 0.0.5​

• Atualização de plugins externos para versões mais recentes corrigindo vulnerabilidades dos mesmos.

Versão 0.0.4​

• Correção de câmera invertida para capturas usando câmera traseira dos celulares.

Versão 0.0.3​

• Versão inicial.

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Este guia foi elaborado para ajudá-lo a implementar o SDK Web de forma rápida e fácil. Abaixo veja o passo a passo de todo o processo de integração. Após isso, caso deseje personalizar a experiência, não deixe de ver a seção Personalização Web.

Inicializar o SDK

Para começar, você deve efetuar 3 passos simples em seu projeto:

Instancie um novo Builder:

const unicoCameraBuilder = new UnicoCheckBuilder();

Especifique o caminho dos arquivos adicionais (caso adicionados em seu projeto):

unicoCameraBuilder.setResourceDirectory("/resources");

Especifique o caminho dos arquivos dos modelos de IA, caso utilize a funcionalidade de Câmera Inteligente

unicoCameraBuilder.setModelsPath("https://meusite.com.br/models");

Configuração de ambientes

É possível configurar o ambiente que será utilizado na execução da SDK. Utilize o enumerado SDKEnvironmentTypes que contém os seguintes enumerados:

• SDKEnvironmentTypes.PROD: para ambiente de Produção;

• SDKEnvironmentTypes.UAT: para ambiente de Homologação.

Veja como implementar no exemplo abaixo:

import {
  ...
  UnicoCheckBuilder,
  SDKEnvironmentTypes
  ...
} from "unico-webframe"

unicoCameraBuilder.setEnvironment(SDKEnvironmentTypes.UAT);

Implementar as funções de callback

Um dos objetos que deve ser passado como parâmetro ao método responsável por renderizar o frame de captura é o de callback. Este objeto deverá conter funções de callback para casos de sucesso e erro, como exemplificados abaixo.

  const callback = {
    on: {
      success: (obj) => {
        console.log(obj.base64);
        console.log(obj.encrypted);        
      },
      error: (error) => {
        console.error(error)
        //confira na aba "Referências" sobre os erros possíveis
      }
    }
  };

Este objeto é obrigatório e caso não seja corretamente implementado (contemplando todos os eventos de success ou error) gera uma exceção, que caso não tratada, é exibida no console do usuário.

Configurar e iniciar

Para iniciar a câmera com as configurações feitas até aqui, é preciso criar uma instância do builder através do método build().

const unicoCamera = unicoCameraBuilder.build();

Em seguida, com a câmera "montada", deve-se configurar o modo de captura da câmera.

A preparação da câmera será efetuada a partir do método prepareSelfieCamera(), disponibilizado a partir do builder. Este método recebe 2 parâmetros:

• A classe UnicoConfig obtida neste passo;

• Modo de câmera desejado, sendo eles:

  • SelfieCameraTypes.NORMAL para o modo de câmera normal;

  • SelfieCameraTypes.SMART para o modo de câmera inteligente.

Este método gera uma promise que ao ser resolvida, devolve um objeto que é utilizado para efetivamente abrir a câmera através do método open, que recebe como parâmetro as funções de callback configuradas no passo acima.

Caso deseje utilizar a captura automática, passe o parâmetro Unico.SelfieCameraTypes.SMART para o método prepareSelfieCamera.

Para a captura inteligente, os modelos de visão computacional também devem ser carregados através do método setModelsPath, conforme explicado no primeiro passo deste guia.

Usando a classe UnicoConfig:

const config = new UnicoConfig()
  .setProjectNumber("<YOUR_PROJECT_NUMBER>")
  .setProjectId("<YOUR_PROJECT_ID>")
  .setMobileSdkAppId("<YOUR_MOBILE_SDK_APP_ID>")
  .setHostname("<YOUR_HOSTNAME>")
  .setHostInfo("<YOUR_HOST_INFO>")
  .setHostKey("<YOUR_HOST_KEY>");

  unicoCamera.prepareSelfieCamera(
    config, 
    SelfieCameraTypes.SMART
  ).then(cameraOpener => {
    cameraOpener.open(callback);
  }).catch(error => {
    console.error(error);
    // confira na aba "Referências" sobre os erros possíveis
  });

Configurar modo de captura em iFrame's

É possível utilizar o SDK Web com Liveness Interativo embarcado em um iFrame, para isso é preciso realizar uma implementação semelhante a seção anterior na preparação da câmera.

A preparação da câmera será efetuada através do método prepareSelfieCameraForIFrame(), também disponibilizado a partir do builder. Este método recebe os mesmos parâmetros do prepareSelfieCamera():

const unicoCamera = unicoCameraBuilder.build();

const config = new UnicoConfig()
  .setProjectNumber("<YOUR_PROJECT_NUMBER>")
  .setProjectId("<YOUR_PROJECT_ID>")
  .setMobileSdkAppId("<YOUR_MOBILE_SDK_APP_ID>")
  .setHostname("<YOUR_HOSTNAME>")
  .setHostInfo("<YOUR_HOST_INFO>")
  .setHostKey("<YOUR_HOST_KEY>");

  unicoCamera.prepareSelfieCameraForIFrame(
    config, 
    SelfieCameraTypes.SMART
  ).then(cameraOpener => {
    cameraOpener.open(callback);
  }).catch(error => {
    console.error(error);
    // confira na aba "Referências" sobre os erros possíveis
  });

Implementação do elemento iFrame

Para que a captura funcione corretamente é necessário implementar o elemento <iframe> como no exemplo abaixo:

<iframe allow="fullscreen;camera;geolocation" allowFullScreen src="your_app_url"></iframe>

Comportamento em tela cheia​

Para executar a captura é necessário estar no modo tela cheia do browser para que o SDK possa se redimensionar automaticamente. Sendo assim, ao executar a captura, o SDK apresenta uma tela solicitando a abertura do frame em modo tela cheia. Veja no exemplo a seguir:

Após permitir o uso de tela cheia, o frame de captura abrirá normalmente:

Realize um requisição POST na API REST do by Client

A captura das imagens é apenas a primeira parte da jornada. Após capturar a imagem, é necessário enviar o encrypted gerado pelo SDK para as APIs REST do by Client. Saiba mais na seção CreateProcess do by Client.

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Este guia foi elaborado para ajudá-lo a implementar o SDK Web de forma rápida e fácil. Abaixo veja o passo a passo de todo o processo de integração. Após isso, caso deseje personalizar a experiência, não deixe de ver a seção Personalização Web.

Frames de documentos disponíveis

Neste modo de câmera, existe um frame de captura para auxiliar o usuário a posicionar o documento corretamente. Após posicionar o documento corretamente, o usuário deve clicar no botão para realizar a captura da foto do documento.

Neste modo de câmera é possivel capturar os documentos:

• CPF: Captura da frente do CPF;

• CNH: Captura da CNH aberta;

• CNH frente: Captura da frente da CNH;

• CNH verso: Captura do verso da CNH;

• RG frente: Captura da frente do RG;

• RG verso: Captura do verso do RG;

• Outros: Captura de qualquer outro documento.

Inicializar o SDK

Para começar, você deve efetuar 2 passos simples em seu projeto:

Instancie um novo Builder:

const unicoCameraBuilder = new UnicoCheckBuilder();

Especifique o caminho dos arquivos adicionais (caso adicionados em seu projeto):

unicoCameraBuilder.setResourceDirectory("/resources");

Configurar tamanho do frame

É recomendado que você configure o tamanho do frame dentro de sua aplicação, a fim de otimizar a área de captura dentro de seu WebApp. Confira abaixo como fazer esta configuração para Web Desktop ou Mobile.

<div class="container">
  <div id="box-camera"></div>
</div>

.container {
  width: 800px;
  height: 600px;
  position: relative;
}

Implementar as funções de callback

Um dos objetos que é necessário passar como parâmetro ao método responsável por renderizar o frame de captura é o de callback. Este objeto deve conter funções de callback para casos de sucesso e erro, como exemplificados abaixo.

  const callback = {
    on: {
      success: (obj) => {
        console.log(obj.base64);
        console.log(obj.encrypted);
      },
      error: (error) => {
        console.error(error)
        //confira na aba "Referências" sobre os erros possíveis
      },
    }
  };

Este objeto é obrigatório e caso não seja corretamente implementado (contemplando todos os eventos de success ou error gera uma exceção, que caso não tratada, é exibida no console do usuário).

Configurar e iniciar câmera

Para iniciar a câmera com as configurações feitas até aqui, é preciso criar uma instância do builder através do método build().

const unicoCamera = unicoCameraBuilder.build();

Em seguida, com a câmera "montada", deve-se configurar o modo de captura da câmera.

A preparação da câmera é efetuada a partir do método prepareDocumentCamera(), disponibilizado a partir do builder. Este método recebe 2 parâmetros:

• A classe UnicoConfig obtida neste passo;

• Tipo de documento a ser capturado, sendo eles:

Este método gera uma promise que ao ser resolvida, devolve um objeto que é utilizado para efetivamente abrir a câmera através do método open, que recebe como parâmetro as funções de callback configuradas no passo acima.

Abaixo um exemplo utilizando a captura de CNH:

Usando a classe UnicoConfig:

  const config = new UnicoConfig()
    .setProjectNumber("<YOUR_PROJECT_NUMBER>")
    .setProjectId("<YOUR_PROJECT_ID>")
    .setMobileSdkAppId("<YOUR_MOBILE_SDK_APP_ID>")
    .setHostname("<YOUR_HOSTNAME>")
    .setHostInfo("<YOUR_HOST_INFO>")
    .setHostKey("<YOUR_HOST_KEY>");

  unicoCamera.prepareDocumentCamera(
    config, 
    DocumentCameraTypes.CNH
  ).then(cameraOpener => {
    cameraOpener.open(callback);
  }).catch(error => {
    console.error(error);
    // confira na aba "Referências" sobre os erros possíveis
  });

Realize um requisição POST na API REST do by Client

A captura das imagens é apenas a primeira parte da jornada. Após capturar a imagem, é necessário enviar o base64 gerado pelo SDK para as APIs REST do by Client. Saiba mais na seção CreateProcess do by Client.

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Browsers compatíveis

O frame de captura disponibilizado por meio do SDK, é compatível com as seguintes combinações de browsers e sistemas operacionais:

De forma geral, o SDK da suporte a WebRTC e versões mais recentes dos browsers listados acima. Por questões de compatibilidade e segurança, o funcionamento em versões muito antigas destes browsers não é garantido.

Funcionamento em Webview

É um componente do sistema que permite que as aplicações Android ou iOS exibam conteúdos da web diretamente dentro do aplicativo, baseado no mesmo projeto de código. Sendo responsável pela navegação em sites e conteúdo da web dentro dos aplicativos.

Pré-requisitos

• É necessário ter realizado a implantação do SDK Web em uma aplicação que contenha um domínio seguro com protocolo https.

Compatibilidade com sistemas operacionais

Android:

O SDK Web tem compatibilidade com webviews executadas no Android 8 (API 26) ou superior.

Para que o SDK tenha um funcionamento correto é necessário adicionar algumas permissões e configurações ao arquivo AndroidManifest, são elas:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.webkit.PermissionRequest" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />
<uses-feature android:name="android.hardware.camera2.full" />
<uses-feature android:name="android.hardware.camera2.autofocus" />

É recomendado o uso de webviews baseadas no Chromium com algumas customizações para melhor funcionamento do JavaScript. É possível encontrar um exemplo de implementação através das nossas PoCs aqui.

iOS

O SDK Web tem compatibilidade com webviews executadas no iOS 13 ou superior.

Para que o SDK tenha um funcionamento correto é necessário adicionar algumas permissões e configurações ao arquivo info.plist, são elas:

<key>NSCameraUsageDescription</key>
<string>Camera usage description</string>

<key>NSLocationWhenInUseUsageDescription</key>
<string>Mensagem da cliente</string>

O iOS fornece duas maneiras de se utilizar Webviews em aplicações, são elas: WKWebView e SFSafariViewController. Recomendamos o uso do SFSafariViewController para uma melhor compatibilidade com os recursos do DOM. É possível encontrar um exemplo de implementação através das nossas PoCs aqui.

Compatibilidade com frameworks híbridos

O componente foi homologado somente em camadas nativas, para que seja utilizado em frameworks híbridos (Flutter ou React Native) é necessário implementar na camada nativa do Android e/ou iOS.

Instalando o SDK Web

Para implementar o SDK Android da plataforma Unico IDCloud ao seu aplicativo Android, siga o passo a passo listado abaixo:

<meta
  http-equiv="Content-Security-Policy"
  content="
      script-src 'self' 'unsafe-eval' *.googleapis.com *.acesso.io *.unico.run *.unico.io *.unico.app; 
      worker-src 'self' blob:; 
      child-src 'self' blob:;
            style-src 'self' 'unsafe-inline' *.googleapis.com *.acesso.io *.unico.run *.unico.io *.unico.app;
            font-src 'self' https://fonts.gstatic.com *.acesso.io *.unico.run *.unico.io *.unico.app;
            img-src 'self' data: blob: *.acesso.io *.unico.run *.unico.io *.unico.app;
            media-src 'self' data: *.acesso.io *.unico.run *.unico.io *.unico.app;
      script-src-elem 'self' 'unsafe-inline' blob: *.googleapis.com *.acesso.io *.unico.run *.unico.io *.unico.app"
/>

{
 "project_info": {
  "project_number": "8127389179831981991",
  "project_id": "SDK"
 },
 "client_info": {
  "mobilesdk_app_id": "SDK",
  "ios_client_info": {
   "bundle_identifier": "https://appunico.com.br"
  }
 },
 "host_info": {
  "host_info": "IQDyuMFE7Oef...",
  "host_key": "NNy76QlNHAW2P..."
 }
}

import { UnicoConfig } from "unico-webframe"

const config = new UnicoConfig()
  .setHostname("<YOUR_HOSTNAME>")
  .setHostKey("<YOUR_HOST_KEY>");

import { UnicoConfig } from "unico-webframe"

const config = new UnicoConfig()
  .setProjectNumber("<YOUR_PROJECT_NUMBER>")
  .setProjectId("<YOUR_PROJECT_ID>")
  .setMobileSdkAppId("<YOUR_MOBILE_SDK_APP_ID>")
  .setHostname("<YOUR_HOSTNAME>")
  .setHostInfo("<YOUR_HOST_INFO>")

npm install unico-webframe

yarn add unico-webframe

import { UnicoCheckBuilder, SelfieCameraTypes, UnicoThemeBuilder, DocumentCameraTypes, UnicoConfig, LocaleTypes } from 'unico-webframe'

import { UnicoCheckBuilder, SelfieCameraTypes, UnicoThemeBuilder, DocumentCameraTypes, UnicoConfig, LocaleTypes } from 'UnicoCheckBuilder.min.js'

Pronto. Finalizada a instalação do SDK, siga para a implementação lendo o material Guia de uso e integração a seguir:

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

É disponibilizado a seguir a lista de possíveis códigos de erro do SDK Web.

Possíveis erros do prepareCamera:

Possíveis erros do openCamera​

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.