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 seus aplicativos Android


Pré-requisitos do 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.

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

  • Android: 5.0 (API 21);

  • Kotlin: 1.6.

Dispositivos compatíveis


Este SDK não funciona em emuladores, somente em dispositivos físicos.

O SDK Android é compatível com a grande maioria dos dispositivos que possuam Android 5.0 (API de nível 21) ou versões superiores.

A tabela a seguir lista os dispositivos testados em laboratório, além da disponibilidade das extensões do fornecedor/fabricante. Algumas extensões listadas podem estar sujeitas as API ou SKUs específicos do fabricante. Clique abaixo para ver os dispositivos testados:

Instalando o SDK Android


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

1

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

/build.gradle
// 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):

gradle.properties
# 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

2

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:

AndroidManifest.xml
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />

3

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:

app/build.gradle
/* unico */
implementation 'io.unico:capture:$version'

Ao compilar o projeto, você pode se deparar com o seguinte erro:

  • 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 
      } 
}

4

Obtendo as credenciais

  • 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

5

Embarcando as credenciais em seu projeto

Implemente o protocolo AcessoBioConfigDataSource em sua classe:

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;
    }
}
Método depreciado - Java
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;
    }
}
Método depreciado - Kotlin
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
    }
}

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.

Atualizado

Institucional

Sobre nós

Copyright © 2024 unico. All rights reserved