Skip to main content

Preparation

To setup Android SDK correctly, you must complete the steps below.

Requirements​

The minimum requirements for the SDK are:

  • API Level 21
  • compileSDKVersion 33

Required Permissions​

This SDK makes use of the devices Camera, Location and NFC permissions. If you don't want to use location service, please provide in init method.

You must have the folowing keys in your application's manifest file:

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.NFC" />

ProGuard Rules​

  • If you're using ProGuard in your application, you must add the following block to your rules.
-keep class ai.** {*;}
-dontwarn ai.**
-keep class datamanager.** {*;}
-dontwarn datamanager.**
-keep class networkmanager.** {*;}
-dontwarn networkmanager.**

-keep class org.jmrtd.** {*;}
-keep class net.sf.scuba.** {*;}
-keep class org.bouncycastle.** {*;}
-keep class org.spongycastle.** {*;}
-keep class org.ejbca.** {*;}

-dontwarn org.ejbca.**
-dontwarn org.bouncycastle.**
-dontwarn org.spongycastle.**
-dontwarn org.jmrtd.**
-dontwarn net.sf.scuba.**

Installation​

  • Add the dependency to your app's build.gradle
dependencies {
  implementation 'ai.amani.android:AmaniAi:3.3.0' // Add only this line
}
  • Enable DataBinding the the module build.gradle file by adding this line into android section
dataBinding { enabled true }
  • Add our maven repository to the buildscript -> repositories and buildscript -> allproject sections.
maven { url "https://jfrog.amani.ai/artifactory/amani-sdk"}

You're now ready to use our SDK.