# Installation Guide
## Development Environment Preconditions
Your development environment must meet the following prerequisites:
| |
| ----------------------------------------------------------------------------------------------------------- |
| - Have version 9 or higher of Android Studio installed (Google's official development IDE);
|
| - Have the Android SDK version 21 or higher;
|
| - Have the Unico Maven repository configured.
|
{% hint style="info" %}
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.8.22.
{% endhint %}
## Compatible Devices
{% hint style="info" %}
This SDK does not work on emulators, only on physical devices.
{% endhint %}
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:
{% tabs %}
{% tab title="Click to collapse" %}
{% endtab %}
{% tab title="Click to view tested devices" %}
| ASUS - X01BDA | 10.0.0 |  | Físico |
| ------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- |
| ASUS - Z01KD | 8.0.1 |  | Físico |
| HUAWEY - P30 Lite | 9.0.0 |  | Físico |
| LG - K22 | 10.0.0 |  | Físico |
| LG - Q6 | 7.0.0 |  | Físico |
| MOTOROLA - Moto one macro | 10.0.0 |  | Físico |
| MOTOROLA - Moto G4 | 6.0.1 |  | Físico |
| MOTOROLA - Moto G5s Plus | 8.1.0 |  | Físico |
| MOTOROLA - Moto G6 Play | 9.0.0 |  | Físico |
| MOTOROLA - Moto G7 Play | 10.0.0 |  | Físico |
| MOTOROLA - Moto G7 Power | 10.0.0 |  | Físico |
| MOTOROLA - Moto G8 Power Lite | 10.0.0 |  | Físico |
| SAMSUNG - A01 | 10.0.0 |  | Físico |
| SAMSUNG - J8 SM J810M | 8.1.0 |  | Físico |
| SAMSUNG - Galaxy A30s SM-A307GT | 10.0.0 |  | Físico |
| SAMSUNG - Galaxy A51 | 10.0.0 |  | Físico |
| SAMSUNG - Galaxy A71 | 11.0.0 |  | Físico |
| SAMSUNG - Galaxy S20+ | 11.0.0 |  | Físico |
| SAMSUNG - s10e | 11.0.0 |  | Físico |
| XIAOMI - Mi 8 Lite | 9.0.0 |  | Físico |
| XIAOMI - Mi 8 Lite | 10.0.0 |  | Físico |
| XIAOMI - Poco X3 | 10.0.0 |  | Físico |
| XIAOMI - Redmi Note 8 | 10.0.0 |  | Físico |
| XIAOMI - Redmi Note 8 Pro | 10.0.0 |  | Físico |
| XIAOMI - Redmi Note 9 | 10.0.0 |  | Físico |
| XIAOMI - Redmi Note 9 Pro | 10.0.0 |  | Físico |
| GOOGLE - Pixel sailfish | 8.0.0 |  | Virtual (TestLab) |
| HUAWEY - ALE L23 | 5.0.0 |  | Virtual (TestLab) |
| HUAWEY - ANE LX1 | 9.0.0 |  | Virtual (TestLab) |
| HUAWEY - ANE LX2 | 9.0.0 |  | Virtual (TestLab) |
| HUAWEY - COR L29 | 8.1.0 |  | Virtual (TestLab) |
| HUAWEY - MHA L29 | 7.0.0 |  | Virtual (TestLab) |
| HUAWEY - NEO L29 | 9.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SC 02J | 8.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM G891A | 9.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM G930AZ | 8.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM G935A | 8.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM G965N | 9.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM G965U1 | 8.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM G981U1 | 10.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM J727V | 8.1.0 |  | Virtual (TestLab) |
| SAMSUNG - SM N950F | 9.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM N950N | 9.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM N950U | 8.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM N960F | 9.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM N960N | 9.0.0 |  | Virtual (TestLab) |
| SAMSUNG - SM N960U1 | 8.1.0 |  | stLab) |
| {% endtab %} | | | |
| {% endtabs %} | | | |
## Installing the Android SDK
To implement the Unico IDCloud Android SDK into your Android application, follow the step-by-step instructions listed below:
{% stepper %}
{% step %}
### 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:
{% code title="/build.gradle" overflow="wrap" %}
```java
// 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"
}
}
}
```
{% endcode %}
Enable AndroidX support in your `gradle.properties` file at the root of your project (this ensures better performance and operation of the capture framework):
# 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
{% endstep %}
{% step %}
### 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`:
{% code title="AndroidManifest.xml" overflow="wrap" %}
```java
```
{% endcode %}
{% endstep %}
{% step %}
### 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.
{% code title="app/build.gradle" overflow="wrap" %}
```java
/* unico */
implementation 'io.unico:capture:$version'
```
{% endcode %}
{% hint style="warning" %}
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:
{% endhint %}
```java
android {
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
```
{% endstep %}
{% step %}
### Obtaining Credentials
* Contact the CS and/or Onboarding team.
* Request the SDK Key by providing the identifiers of your applications: **PackageID** and **SHA-256** for Android.
* 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**.
{% endstep %}
{% step %}
### Embedding Credentials in Your Project
* Implement the **`AcessoBioConfigDataSource`** protocol in your class:
{% tabs %}
{% tab title="Java" %}
```java
package
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;
}
}
```
{% endtab %}
{% tab title="Kotlin" %}
```kotlin
package
import com.acesso.acessobio_android.onboarding.AcessoBioConfigDataSource
class UnicoConfig : AcessoBioConfigDataSource {
override fun getBundleIdentifier(): String {
return BUNDLE_IDENTIFIER
}
override fun getHostKey(): String {
return SDK_KEY
}
}
```
{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}
Depracated Method - Java
```java
package
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
```kotlin
package
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. After completing the SDK installation, proceed to the implementation by reading the following material:
{% embed url="" %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://devcenter.unico.io/unico-idcloud/by-client-integration/sdk/available-sdks/android-sdk/installation-guide.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.