Getting started
This section introduces the first steps to run our Android SDKs. If you have questions or suggestions, tell us!
You can find code examples on our Github.
Terms & Policies
When using our SDKs, please make sure that you agree with our Privacy Policy and our Terms and Conditions of Use.
Current versions
Stable
SDK | Dependency |
---|---|
| |
| |
| |
| |
| |
|
Release Candidates
SDK | Dependency |
---|---|
| |
| |
|
Compatibility
Settings | Minimum version | Reason |
---|---|---|
| 21 | - According to google, it covers 94% of the world's Android devices - Also, it is the minimum version required by CameraX - Document detection algorithm has API 21 as minimum version |
| 33 | API 33 is the minimum version required by CameraX |
Java version | 8 | Lambda functions |
Project settings
Add these settings to your app-level build.gradle
:
As our SDKs activities use Data Binding, it is required that you enable this setting within your app. The compileOptions
setting is required for SDK's built-in lambda functions, which were released in Java 8. The noCompress
setting tells the compiler not to compress files with the .tflite
extension used in the DocumentDetector.
Importing the SDKs
Remotely
To import our SDKs, add our maven repository to your project-level build.gradle
:
If you are using the Gradle 7+ version, add our maven repository inside the dependencyResolutionManagement
method in the settings.gradle
file, instead of the build.gradle
:
After that, add the SDK dependency you want to use in your app to the app-level build.gradle
:
Locally
1. Download the .aar
and .pom
corresponding files from our repository to directly add the transitive SDK dependencies to your project.
This is necessary as the .aar
file does not carry transitive dependencies. To download, access the following URL, replacing {sdkName}
and {sdkVersion}
corresponding to the SDK you want to use: https://repo.combateafraude.com/android/release/com/combateafraude/sdk/{sdkName}/{sdkVersion}/{sdkName}-{sdkVersion}.aar
2. Add the .aar
file to the path <project_folder>/app/libs
.
3. In your app-level build.gradle
add the libs
folder as a dependency repository, add the .aar
file downloaded earlier in step 1 and all transitive dependencies in your app's dependencies:
ProGuard settings
If you use ProGuard or a similar tool that includes shrink or obfuscation rules in your project, you may need to add these exceptions for our SDKs to work properly.
R8 / PROGUARD
If you are using R8 the shrinking and obfuscation rules are included automatically.
ProGuard users must manually add the options from retrofit2.pro.
You might also need rules for OkHttp and Okio which are dependencies of this library.
Last updated