Skip to main content

Installation

The Scanbot SDK for Android is distributed through our private Maven repository server (nexus.scanbot.io), which needs to be specified in the settings.gradle.kts file in the root folder of your project:

// settings.gradle.kts in the root of the project:
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()

// Add Scanbot SDK maven repositories here:
maven(url = "https://nexus.scanbot.io/nexus/content/repositories/releases/")
maven(url = "https://nexus.scanbot.io/nexus/content/repositories/snapshots/")
}
}

Afterward, the dependencies can be added in the dependencies section of your Android application project configuration, usually in the app/build.gradle.kts file:

Main SDK dependencies

For Package I features:

implementation("io.scanbot:sdk-package-1:$scanbotSdkVersion")

Or alternatively for Package III features:

implementation("io.scanbot:sdk-package-3:$scanbotSdkVersion")

Get the latest $scanbotSdkVersion from the Changelog.

Ready-to-Use UI dependencies

The Scanbot SDK Ready-to-Use UI Components are distributed as separate packages:

  • sdk-package-ui: for Ready-to-Use UI v1 screens
  • io.scanbot:rtu-ui-v2-bundle: for Ready-to-Use UI v2 screens (only Document Scanner feature so far)

Therefore, if you plan to integrate our Ready-to-Use UI screens, add additional dependencies to your project as well:

// For Ready-to-Use UI v1 screens
implementation("io.scanbot:sdk-package-ui:$scanbotSdkVersion")

// For Ready-to-Use UI v2 screens (only Document Scanner feature so far)
implementation("io.scanbot:rtu-ui-v2-bundle:$scanbotSdkVersion")

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get your free Trial License

What do you think of this documentation?