Skip to main content

License Handling | 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.

License Checks in Production Apps​

If your Scanbot Barcode Scanner SDK license has expired, any call of the Scanbot Barcode Scanner SDK API will terminate your app or result in an error. To prevent this you should always check for license expiration during the runtime by calling the method ScanbotBarcodeSDK.getLicenseInfo(). If the result returns result.data?.isLicenseValid !== true, you should disable any usage of the Scanbot Barcode Scanner SDK functions or UI components in your app. We highly recommend implementing a suitable handling of this case in your app!

ScanbotBarcodeSDK.getLicenseInfo()​

Use this function to check the current state of the license. The SDK must be initialized.

ScanbotBarcodeSDK.getLicenseInfo(function(result) {
    if (result.data?.isLicenseValid === true) {
        // Making your calls of the Scanbot Barcode Scanner SDK Plugin API is now safe.
        // e.g. start the Barcode Scanner:
        ScanbotBarcodeSDK.startBarcodeScanner(...);
    }
    else {
        // Implement a suitable handling (e.g. disable Scanbot functionality in your App)
        alert("Scanbot SDK license is not valid!");
    }
}, sdkErrorCallback);

Result:

  • result.data?.isLicenseValid Contains a boolean status value of the license. true means the Scanbot Barcode Scanner SDK license is valid and all features can be used normally. false means the license is not valid and any call of the Scanbot Barcode Scanner SDK API will not work or result in an error.
  • result.data?.licenseStatus LicenseStatus enum type that describes the status of the current license key.
  • result.data?.licenseStatusMessage? A detailed message string for debugging purposes. Not intended for displaying in the UI for the end user.
  • result.data?.licenseExpirationDate? The license expiration date in milliseconds.

License Status Types​

  • LicenseStatus.Okay OK, the license key is valid.
  • LicenseStatus.Trial No license key installed, trial mode is active.
  • LicenseStatus.NotSet License error: No license installed.
  • LicenseStatus.Corrupted License error: The license key string is corrupted. Please check the format.
  • LicenseStatus.WrongOS License error: The license key does not include support for current Operating System (Android or iOS).
  • LicenseStatus.AppIDMismatch License error: The license key does not match the Application ID (on Android) or Bundle ID (on iOS) of the this app.
  • LicenseStatus.Expired License error: License has expired.

Updating the License in Production Apps​

To renew an expired license or extend a valid license with new Scanbot Barcode Scanner SDK features, you will have to update your app in the App Store or 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.

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