Instalação
AMBIENTE DE DESENVOLVIMENTO
É necessário que seu ambiente de desenvolvimento esteja de acordo com os seguintes pré-requisitos:
- Possuir a versão 9 ou superior do Android Studio instalado (IDE oficial de desenvolvimento do Google);
- Possuir a versão do SDK Android na versão 21 ou superior;
- Possuir o repositório Maven da Unico configurado.
CONFIGURAR REPOSITÓRIO MAVEN
O SDK Android é disponibilizado através de um Repositório Maven, adicione ao bloco repositories do arquivo build.gradle existente na raiz do seu projeto:
// Top-level build file where you can add configuration options common to all sub-projects/modules.
allprojects {
repositories {
google()
jcenter()
maven {
url "https://maven-sdk.unico.run/sdk-mobile"
}
}
}
Habilite o suporte ao AndroidX ao em seu arquivo gradle.properties na raiz de seu projeto (isto garante uma melhor performance e funcionamento do frame de captura):
# Project-wide Gradle settings.
# https://developer.android.com/topic/libraries/support-library/androidx-rn
android.useAndroidX=true
# Automatically convert third-party libraries to use AndroidX
android.enableJetifier=true
PERMISSÕES PARA UTILIZAÇÃO DA CÂMERA E INTERNET
Para utilizar o método de abertura de câmera e internet em seu projeto é necessário adicionar as permissões em seu arquivo AndroidManifest.xml:
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />
INCLUSÃO DA DEPENDÊNCIA
Após configurar o SDK Android, basta importá-lo em seu projeto. Para isto, adicione acessobio-android ao bloco dependencies do arquivo app/build.gradle.
A dependência deve ser incluída em um arquivo diferente do que foi utilizado no passo anterior. Neste passo, é necessário utilizar o arquivo build.gradle referente ao módulo e não ao projeto:
/* unico */
implementation 'io.unico:capture:$version'
Ao compilar o projeto, se o erro for exibido:
Invoke-customs are only supported starting with android 0 --min-api 26
Por incompatibilidade da versão do frame min-26. Adicione as linhas a seguir ao bloco compileOptions, no mesmo arquivo app/build.gradle:
android {
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
OBTENDO AS CREDENCIAIS
Para utilizar o SDK Android é necessário obter a credencial SDK Key, uma chave única de identificação do cliente gerada pela equipe da Unico.
- Entre em contato com o CSs e/ou time de Onboarding.
- Solicite a SDK Key informando os identificadores de suas aplicações. Bundle Identifier para iOS, PackageID para Android e Host para WEB.
- Os identificadores de suas aplicações serão vinculados a SDK Key pela equipe da Unico.
- Você recebe a sua SDK Key para implementar o AcessoBioConfigDataSource
Credenciais (Client API Key) - Método Depreciado
Para importar as credenciais (Client API Key) em seu projeto, utilize o guia a seguir:
- Acesse a sua instância com o login e senha;
- Role a barra de menus para baixo e clique no menu Configurações, em seguida clique no menu Integração e por fim clique no menu API Key;
- Para criar uma API Key clique em + Nova API Key ou para editar clique sob a API Key desejada;
- Se desejar utilizar o modo câmera de selfie com Liveness, verifique se o campo Utiliza liveness com interação está preenchido com a opção SIM. Se estiver preenchido com NÃO, ou não estiver aparecendo, entre em contato com o suporte através da Central de ajuda e solicite a ativação; Para mais informações sobre LIVENESS COM INTERAÇÃO, clique aqui.
- No campo Utiliza autenticação segura na SDK selecione a opção Sim;
- Expanda a seção SDK Android, adicione a identificação do projeto e o Package Name;
- Por fim, clique em Salvar;
- Volte para a seção APIKey;
- Escolha a API Key configurada, na coluna Bundle, clique no botão de Download;
- Uma nova seção é aberta, selecione a opção Android;NOTA
Se a aba não abrir, verifique se o seu navegador está bloqueando os pop-ups.
- Clique em Gerar e automaticamente uma nova aba é aberta em seu navegador contendo informações do projeto em formato JSON;
- Salve esse JSON.
EMBARCANDO AS CREDENCIAIS EM SEU PROJETO
Para embarcar a SDK Key ao projeto, implemente o protocolo AcessoBioConfigDataSource em sua classe.
- Java
- Kotlin
package <package_name>
import com.acesso.acessobio_android.onboarding.AcessoBioConfigDataSource;
public class UnicoConfig implements AcessoBioConfigDataSource {
@Override
public String getBundleIdentifier() {
return BUNDLE_IDENTIFIER;
}
@Override
public String getHostKey() {
return SDK_KEY;
}
}
package <package_name>
import com.acesso.acessobio_android.onboarding.AcessoBioConfigDataSource
class UnicoConfig : AcessoBioConfigDataSource {
override fun getBundleIdentifier(): String {
return BUNDLE_IDENTIFIER
}
override fun getHostKey(): String {
return SDK_KEY
}
}
Credenciais (Client API Key) - Método Depreciado
- Java
- Kotlin
package <package_name>
import com.acesso.acessobio_android.onboarding.AcessoBioConfigDataSource;
public class UnicoConfig implements AcessoBioConfigDataSource {
@Override
public String getProjectNumber() {
return PROJECT_NUMBER;
}
@Override
public String getProjectId() {
return PROJECT_ID;
}
@Override
public String getMobileSdkAppId() {
return MOBILE_SDK_APP_ID;
}
@Override
public String getBundleIdentifier() {
return BUNDLE_IDENTIFIER;
}
@Override
public String getHostInfo() {
return HOST_INFO;
}
@Override
public String getHostKey() {
return HOST_KEY;
}
}
package <package_name>
import com.acesso.acessobio_android.onboarding.AcessoBioConfigDataSource
class UnicoConfig : AcessoBioConfigDataSource {
override fun getProjectNumber(): String {
return PROJECT_NUMBER
}
override fun getProjectId(): String {
return PROJECT_ID
}
override fun getMobileSdkAppId(): String {
return MOBILE_SDK_APP_ID
}
override fun getBundleIdentifier(): String {
return BUNDLE_IDENTIFIER
}
override fun getHostInfo(): String {
return HOST_INFO
}
override fun getHostKey(): String {
return HOST_KEY
}
}
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.