Guia de instalação

Nesta seção, você encontrará todas as informações necessárias para instalação do SDK da plataforma Unico IDCloud em suas aplicações Web

Browsers compatíveis

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

Sistema Operacional

Chrome

Firefox

Safari

Samsung Internet

Opera

Edge

Windows (desktop)

N/A

Android

N/A

iOS

N/A

MacOS (desktop)

N/A

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.

O componente de captura disponibilizado por meio do SDK Web dá suporte às versões igual ou superiores para as tecnologias:

Android: 5.0 (API 21);
iOS: 11.

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:

AndroidManifest.xml

<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:

info.plist

<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.

Quando em execução, o SDK vai solicitar a permissão de abertura da câmera para webview, que por sua vez vai solicitar a mesma para a aplicação nativa. É mandatório que sua aplicação nativa tenha as permissões necessárias ajustadas nos arquivos de configuração.

Nosso suporte é restrito a aplicativos desenvolvidos diretamente nas plataformas nativas Android e iOS, utilizando seus respectivos módulos nativos. No momento, não oferecemos suporte para aplicativos desenvolvidos em frameworks híbridos, como React Native, Ionic ou outras tecnologias de desenvolvimento multiplataforma.

Instalando o SDK Web

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

Configurações de Content Security Policy (CSP)

O SDK Web emprega o uso de Web Workers para aprimorar a segurança e a performance. Por isso é necessário adicionar as seguintes configurações à sua Content Security Policy (CSP):

<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"
/>

Se a sua aplicação possui uma CSP, essa configuração é obrigatória para garantir o funcionamento correto do SDK.

Obtendo as credenciais

Para utilizar o SDK Web é necessário utilizar as credenciais que permitem a abertura da câmera em seu projeto. São essas credenciais que irão garantir a Prova de vida e a proteção anticlone da sua aplicação.

Para obter as credenciais, você deve informar ao seu gerente de projetos ou ao suporte da Unico o Hostname da sua aplicação (ex: https://appunico.com.br), e você receberá um JSON com as credenciais e seu Hostname nele, como no exemplo abaixo:

{
 "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..."
 }
}

Embarcando as credenciais em seu projeto

Implemente a classe UnicoConfig em sua classe:

import { UnicoConfig } from "unico-webframe"

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

Método depreciado:

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>")

Embarcando outros arquivos em seu projeto

A tabela abaixo lista arquivos de recursos adicionais disponíveis para inclusão em seu projeto. Você deve baixa-los e incluí-los em seu projeto para realizar a captura com Prova de vida:

Release do SDK	Release da FaceTec (Clique na numeração para fazer o download dos arquivos adicionais)
3.18.9	9.7.36
3.18.8	9.7.33
3.18.7	9.7.31
3.18.6	9.7.29
3.18.5	9.7.27
3.18.4	9.7.25
3.18.0 -> 3.18.3	9.6.92
3.16.4 -> 3.17.0	9.6.89
3.16.3	9.6.85
3.16.2	9.6.84
3.14.1 -> 3.16.1	9.6.73
3.11.1 -> 3.14.0	9.6.65
3.10.2 -> 3.11.0	9.6.56
3.10.1	9.6.53
3.9.1 -> 3.10.0	9.6.40
3.9.0	9.6.38
3.8.3	9.6.33
3.8.2	9.6.30
3.8.0 -> 3.8.1	9.6.26
3.7.1 -> 3.7.2	9.6.24
3.6.5 -> 3.7.0	9.6.16
3.6.3 -> 3.6.4	9.6.11
3.6.1 -> 3.6.2	9.6.4
3.5.4 -> 3.6.0	9.4.18
3.5.3	9.4.14
3.5.0 -> 3.5.2	9.4.11

Realize o download dos arquivos de IA da SDK

Para realizar o download do arquivo de AI do Unico Check SDK Web clique aqui.

Todos os arquivos adicionais devem estar em um local público e visível para a Web dentro de seu projeto.

Instalação

O SDK Web é disponibilizado através de um pacote npm ou cdn. Para a instalação, siga os passos abaixo de acordo com sua preferência:

Instalação através do pacote NPM

Para instalar o SDK em seu projeto através do npm, basta executar o comando abaixo:

npm install unico-webframe

Ou pelo yarn, com o comando abaixo:

yarn add unico-webframe

Instalação através do CDN

Para instalar o SDK em seu projeto por meio do cdn, basta efetuar o download do arquivo abaixo e importa-lo em seu projeto.

Download da versão 3.18.9.

Importação

Após a instalação dO SDK, basta importa-lo da maneira correta em seu projeto.

Caso tenha instalado o pacote através do npm:

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

Caso tenha instalado o pacote através do cdn:

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:

Guia de uso e integração | Unico IDCloud - DevCenter

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.

AnteriorSDK Web PróximoGuia de uso e integração

Atualizado há 7 dias

Browsers compatíveis

Funcionamento em Webview

Pré-requisitos

Compatibilidade com sistemas operacionais

Android:

iOS

Compatibilidade com frameworks híbridos

Instalando o SDK Web

Configurações de Content Security Policy (CSP)

Obtendo as credenciais

Embarcando as credenciais em seu projeto

Embarcando outros arquivos em seu projeto

Realize o download dos arquivos de IA da SDK

Instalação

Importação

Dúvidas?​

Dúvidas?