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.

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.

To change your app's Package ID you can add a capacitor.config.ts file to your project:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  appId: 'com.company.appname',
  appName: 'My Capacitor App',
};

export default config;

If you are not using TypeScript in your project, you can use a capacitor.config.json file in the same way.

Check the official documentation regarding Capacitor Configuration for more information.

Get a 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.

Initialize​

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 properly initialized before calling any API methods or launching UI screens. Make sure to call the initialization when the app has been launched and initialized already:

  • In an Angular based project call it inside ngOnInit()
  • In a React Project call it in componentDidMount() or inside a useEffect
  • In an Ionic based project use the platform.ready() promise event.
Initialize ScanbotSDK
loading...

It's recommended to implement the SDK initialization in a single location in your app. However, the SDK can be re-initialized multiple times during the app's runtime (e.g. in order to update the license key).

Please check all available initialization properties here.

Logging​

When initializing the Scanbot SDK you can enable logging of the SDK. By default logging is disabled.

const config: ScanbotSdkConfiguration = {
  licenseKey: myLicenseKey,
  loggingEnabled: true
}

const promise = ScanbotSDK.initializeSDK(config);

On Android logs are printed into LogCat. The easiest way to check the log outputs on Android is to use Android Studio or Android Debug Bridge (adb) CLI. (e.g. $ adb logcat)

On iOS all logs are printed to the console. Please use Xcode to check the log outputs.

Please note: While it may be useful for development, consider switching logging OFF in production builds for security and performance reasons!

config.loggingEnabled = !environment.production;

Image Quality / Compression​

initializeSDK can take two more optional parameters that specify the image storage format and compression for generated JPEG images, created by the Document Scanner, Cropping UI, as well as all image manipulation functions like applyImageFilter.

const config: ScanbotSdkConfiguration = {
  storageImageFormat: 'JPG',
  storageImageQuality: 80,
};

ScanbotSDK.initializeSDK(config);
  • storageImageQuality - defines the quality factor of JPEG images. The value must be between 1 and 100, where 100 means maximum quality and largest file size. This parameter is optional. The default value is 80 which is a good compromise between image file size and document legibility.
  • storageImageFormat - either 'JPG' or 'PNG'. The default value is 'JPG'.

Next Steps​

It's recommended to get a trial license key or a full production license to continue with the next steps.

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?

On this page

Scroll to top