Installation Guide

In this section, you will find all the information needed to install the Unico IDCloud platform SDK in your Android applications

Development Environment Preconditions

Your development environment must meet the following prerequisites:

Have the Android SDK version 21 or higher;

Have the Unico Maven repository configured.

The capture component provided through the Android SDK supports versions equal to or higher for the following technologies:

Android: 5.0 (API 21);
Kotlin: 1.6.

Compatible Devices

This SDK does not work on emulators, only on physical devices.

The Android SDK is compatible with the majority of devices running Android 5.0 (API level 21) or higher.

The table below lists the devices tested in the lab, along with the availability of the supplier/manufacturer extensions. Some extensions listed may be subject to specific APIs or SKUs from the manufacturer. Click below to view the tested devices:

Installing the Android SDK

To implement the Unico IDCloud Android SDK into your Android application, follow the step-by-step instructions listed below:

Configuring the Maven Repository

The Android SDK is provided through a Maven Repository. Add the following to the repositories block in the build.gradle file located at the root of your project:

/build.gradle

// Top-level build file where you can add configuration options common to all sub-projects/modules.
allprojects 
{
    repositories {
        google()
        maven { 
            url "https://maven-sdk.unico.run/sdk-mobile" 
        }
    }
}

Enable AndroidX support in your gradle.properties file at the root of your project (this ensures better performance and operation of the capture framework):

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

Camera and Internet Permissions

To use the camera and internet opening method in your project, you need to add the permissions in your file AndroidManifest.xml:

AndroidManifest.xml

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

Adding the Dependency

After configuring the Android SDK, simply import it into your project. To do this, add acessobio-android to the dependencies block in the app/build.gradle file.

The dependency should be included in a file different from the one used in the previous step. In this step, you need to use the build.gradle file for the module, not the project.

app/build.gradle

/* unico */
implementation 'io.unico:capture:$version'

When compiling the project, you may encounter the following error:

Invoke-customs are only supported starting with android --min-api 26

This is due to the incompatibility with the min-26 frame version. Add the following lines to the compileOptions block in the same app/build.gradle file:

android { 
    compileOptions { 
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8 
      } 
}

Obtaining Credentials

Contact the CS and/or Onboarding team.
Request the SDK Key by providing the identifiers of your applications: Bundle Identifier for iOS, PackageID for Android, and Host for WEB.
The identifiers of your applications will be linked to the SDK Key by the Unico team.
You will receive your SDK Key to implement the AcessoBioConfigDataSource.

Embedding Credentials in Your Project

Implement the AcessoBioConfigDataSource protocol in your class:

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

Depracated Method - 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;
    }
}

Deprecated Method - 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
    }
}

Done. Once the SDK installation is complete, proceed to the implementation by reading the following Usage and Integration Guide:

Still need help?

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.

AnteriorAndroid SDK PróximoUsage and Integration Guide

Atualizado há 14 dias

Isto foi útil?

Installation Guide

In this section, you will find all the information needed to install the Unico IDCloud platform SDK in your Android applications

Development Environment Preconditions

Your development environment must meet the following prerequisites:

Have version 9 or higher of installed (Google's official development IDE);

Have the Android SDK version 21 or higher;

Have the Unico Maven repository configured.

The capture component provided through the Android SDK supports versions equal to or higher for the following technologies:

Android: 5.0 (API 21);
Kotlin: 1.6.

Compatible Devices

This SDK does not work on emulators, only on physical devices.

The Android SDK is compatible with the majority of devices running Android 5.0 (API level 21) or higher.

Installing the Android SDK

To implement the Unico IDCloud Android SDK into your Android application, follow the step-by-step instructions listed below:

Configuring the Maven Repository

The Android SDK is provided through a Maven Repository. Add the following to the repositories block in the build.gradle file located at the root of your project:

/build.gradle

// Top-level build file where you can add configuration options common to all sub-projects/modules.
allprojects 
{
    repositories {
        google()
        maven { 
            url "https://maven-sdk.unico.run/sdk-mobile" 
        }
    }
}

Enable AndroidX support in your gradle.properties file at the root of your project (this ensures better performance and operation of the capture framework):

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

Camera and Internet Permissions

To use the camera and internet opening method in your project, you need to add the permissions in your file AndroidManifest.xml:

AndroidManifest.xml

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

Adding the Dependency

After configuring the Android SDK, simply import it into your project. To do this, add acessobio-android to the dependencies block in the app/build.gradle file.

The dependency should be included in a file different from the one used in the previous step. In this step, you need to use the build.gradle file for the module, not the project.

app/build.gradle

/* unico */
implementation 'io.unico:capture:$version'

When compiling the project, you may encounter the following error:

Invoke-customs are only supported starting with android --min-api 26

This is due to the incompatibility with the min-26 frame version. Add the following lines to the compileOptions block in the same app/build.gradle file:

android { 
    compileOptions { 
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8 
      } 
}

Obtaining Credentials

Contact the CS and/or Onboarding team.
Request the SDK Key by providing the identifiers of your applications: Bundle Identifier for iOS, PackageID for Android, and Host for WEB.
The identifiers of your applications will be linked to the SDK Key by the Unico team.
You will receive your SDK Key to implement the AcessoBioConfigDataSource.

Embedding Credentials in Your Project

Implement the AcessoBioConfigDataSource protocol in your class:

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

Depracated Method - 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;
    }
}

Deprecated Method - 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
    }
}

Done. Once the SDK installation is complete, proceed to the implementation by reading the following Usage and Integration Guide:

Guia de uso e integração* | IDCloud APIs

Still need help?

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.

AnteriorAndroid SDK PróximoUsage and Integration Guide

Atualizado há 14 dias

Isto foi útil?