Skip to main content

SDK Initialization

License Key​

In order to run the Scanbot SDK within your production app, you must purchase and use a valid Scanbot SDK license.

Each license key is valid only for a given app bundle identifier. You will be unable to use any of the SDK features if the license key is corrupted, expired, or invalid in any other way.

Trial License​

The Scanbot SDK will run without a license for one minute per session! To get a free, "no-strings-attached" 7-day trial license, please submit the Trial License Form on our website.

Please kindly note that a trial license can only be used in a development and staging environment. You are not allowed to publish your app to the App Store, Play Store, or any 3rd party Android App Store with a trial license.

Purchase a Production License​

To get pricing information and purchase a production license for the Scanbot SDK, please request a quote.

App Identifier​

Every app has a unique identifier (sometimes also known as "bundle identifier" or "application ID"). Your license will be bound to this identifier. To request a trial license or purchase a production license you have to provide us the bundle identifier of your app.

Initialization​

Free Developer Support

We provide free "no-strings-attached" developer support for the implementation & testing of the Scanbot SDK. If you encounter technical issues with integrating the Scanbot SDK or need advice on choosing the appropriate framework or features, please visit our Support Page.

The Scanbot SDK must be initialized before usage. Make sure to run the initialization as early as possible. We recommend implementing the initialization in the Application class of the Android app, and in the AppDelegate class of the iOS app.

Add the following code to your Application class and call it inside of OnCreate:

NET/ReadyToUseUI.Droid/MainApplication.cs
loading...

Furthermore, it is highly recommended to add the flag LargeHeap = true to the Application attribute on the MainApplication since image processing is very memory-intensive.

Updating the License in Production Apps​

To renew an expired license or extend a valid license with new Scanbot SDK features, you will have to update your app in the App Store / Play Store. The expiration date and the feature list of a license are contained in an encrypted data part of the license key string. This means a renewal or extension of a license will cause a new license key string to be generated.

License Checks in Production Apps​

If your Scanbot SDK license has expired, any call of the Scanbot SDK API will terminate your app. To prevent this you should always check for license expiration during the runtime by using the respective property below. If this property returns false, you should disable any usage of the Scanbot SDK functions or UI components.

We highly recommend implementing a suitable handling of this case in your app!

Example code for checking the license status:

NET/ReadyToUseUI.Droid/MainActivity.cs
loading...

Logging​

When initializing the Scanbot SDK you can enable or disable logging of the SDK.

NET/ReadyToUseUI.Droid/MainApplication.cs
loading...

On Android logs are printed into LogCat as well as saved on the device. You can find them in Environment.getExternalStorageDirectory()/debug_logs/[package_name]. Usually it is /sdcard/debug_logs/[package_name].

You can also set enableNativeLogging to true, to enable C++ logging for low level debugging.

While it may be useful for development, consider switching logging off in production builds for security and performance reasons!

Image Quality / Compression​

SBSDKConfiguration has two more optional properties that specify the image storage format and compression for temporary images. Temporary images are all images created by the document scanner, cropping UI, as well as all image manipulation functions like ApplyImageFilter.

NET/ReadyToUseUI.Droid/MainApplication.cs
loading...

What do you think of this documentation?

On this page

Scroll to top