Skip to main content

SDK Initialization | Cordova Barcode Scanner

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.

Getting 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.

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 request a trial license or purchase a production license you have to provide us with the identifier of your app. Please find this identifier in the config.xml file of your Cordova app project:

<widget id="my.awesome.app.id" ...>

Make sure that identifier in config.xml is set before adding the platforms.

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.

ScanbotBarcodeSDK.initializeSdk(successCallback, errorCallback, config) The Scanbot Barcode Scanner SDK must be initialized before usage. Make sure to call the initialization after the deviceready Cordova event has been fired.

The following arguments can be passed as config on initialization:

Options:

  • licenseKey: Your license key for the Scanbot Barcode Scanner SDK.
  • loggingEnabled: Optional logging flag. Recommended enabling for debug builds.
  • storageBaseDirectory: Optional directory as file URI to override the default storage directory. of the Scanbot Barcode Scanner SDK. The SDK stores the optional snapped images in this folder.
  • enableNativeLogging: Optional. Enables Scanbot SDK Core native logging (default is false, Android only).
  • useCameraX: Optional. If set to true, CameraX will be used for the RTU-UI components (default is true, Android only).
  • allowXnnpackAcceleration: Optional. Enables/disables XNNPACK acceleration for TensorFlow ML models, which provides highly optimized implementations of floating-point neural network operators (default is true, Android only).
  • fileEncryptionPassword: Optional. Refer to the section Storage and Encryption for more details.
  • fileEncryptionMode: Optional. Encryption mode that will be used if fileEncryptionPassword is set. AES128 or AES256. Default is AES256.

Example:

import ScanbotBarcodeSDK, { ScanbotBarcodeSdkConfiguration } from 'cordova-plugin-scanbot-barcode-scanner';

// Please note: this is just an example license key string (it is not a valid license)
var myLicenseKey =
    "fXbN2PmyqEAZ+btdkSIS36TuX2j/EE5qxVNcZMXYErbLQ" +
    "3OBnE10aOQxYI8L4UKwHiZ63jthvoFwUevttctBk0wVJ7Z" +
    "+Psz3/Ry8w7pXvfpB1o+JrnzGGcfwBnRi/5raQ2THDeokR" +
    "RB1keky2VBOFYbCfYt3Hqms5txF2z70PE/SBTMTIVuxL7q" +
    "1xcHDHclbEBriDtrHw8Pmhh9FqTg/r/4kRN/oEX37QGp+Y" +
    "3ogwIBbSmV+Cv+VuwtI31uXY3/GkyN/pSJZspIl+exwQDv" +
    "O0O1/R/oAURpfM4ydaWReRJtjW8+b1r9rUgPERguaXfcse" +
    "HlnclItgDfBHzUUFJJU/g==\nU2NhbmJvdFNESwppby5zY" +
    "2FuYm90LmRlbW8ueGFtYXJpbgoxNDg0NjExMTk5CjcxNjc" +
    "KMw==\n";

const config: ScanbotBarcodeSdkConfiguration = {
    licenseKey: this.myLicenseKey,
    loggingEnabled: false
    storageBaseDirectory: 'file:///some/optional/custom/storage-folder/'
  };

ScanbotBarcodeSDK.initializeSdk(function(result) {
    // SDK initialized
    console.log(result);
  }, function(error) {
    // Error initializing the SDK
    console.log('Unable to initialize the Scanbot Barcode Scanner SDK: ' + error);
  }, config);

Logging​

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

On Android logs are printed into LogCat as well as saved on the device. The easiest way to check the log outputs on Android is to use the Android Debug Bridge (adb). (e.g. $ adb -s <DEVICE_ID> shell "logcat")

On iOS all logs are printed to the console. Please use Xcode to check the log outputs. There will be no log files created by the Scanbot Barcode Scanner SDK plugin.

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

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