FAQ

barKoder SDK FAQ

barKoder Barcode Scanner SDK FAQ

The barKoder Barcode Scanner SDK is a high-end data capture tool for Android and iOS mobile devices, compatible with various platforms and frameworks. It only requires internet connectivity for the initial initialization and supports most commonly used barcode symbologies and even OCR scanning for MRZ codes or VIN alphanumerical strings. The SDK has specific technical specifications and minimum requirements and also works on any browser that supports WebAssembly and ResizeObserver, as well as various desktop or server-based scanning.

Licensing is based on devices that successfully initialize and scan at least one barcode.

The SDK does not store any personal information retrieved from scanning a barcode.

1. What is the barcode scanner SDK by barKoder? #

barKoder is a mobile, web and desktop/server barcode scanner SDK for high-end level barcode & Optical Code recognition that features an industry-leading algorithm for empowering all kinds of devices having a camera (smartphones, tablets, etc) with the ability to recognize 1D/2D barcodes or Optical Codes (MRZ & VIN) and capturing their data. 

2. Do I need to be connected to the internet in order to use the barcode scanning function? #

When the SDK starts for the first time, it will require internet connectivity, i.e. when the SDK initially calls our server to verify the license key. However, it won't require connectivity again for the next 30 days following the first initialization and all scanning functions will be performed locally on the device. 

3. Which platforms and frameworks are supported? #

Platforms/frameworks that are supported by the barKoder's Mobile Barcode Scanner SDK include:

  1. Android Native SDK
  2. iOS Native SDK
  3. Web (WASM) SDK
  4. Flutter for both Android and iOS
  5. React Native for both Android and iOS
  6. Capacitor for both Android and iOS
  7. Xamarin for both Android and iOS
  8. MAUI for Android, iOS and Windows
  9. Cordova for both Android and iOS
  10. NativeScript for both Android and iOS 
  11. Python library
  12. Linux
  13. Windows
  14. C#

4. How many symbologies are supported? #

Most of the commonly used barcode symbologies are supported by our mobile barcode scanning SDK. That includes:

Please refer to our documentation page for a detailed list of Supported Symbologies.  

5. What is the process for obtaining a trial license key? #

Getting your evaluation key is now easier than ever.

You only need to register an account on our Developer Portal and utilize the self-service for generating a trial license good for initial duration of 30 days. You can also generate a trial license without registering if you utilize the form on our Trial Page, but that license will only last for 7 days and for any extension requirements, an account will have to be created.

6. Does the SDK have any technical specifications or minimum requirements? #

  • Minimum OS Version is Android 8.0 (API level 26) and iOS 12. We can push the Android to 5 (API level 21) per request
  • Minimum supported Camera Resolution: 1280×720 resolution (HD)
  • Recommend are devices with cameras of at least 8 Mega Pixels featuring Autofocus (AF)
  • Architectures - arm64, armeabi , x86, x86_64 

7. Which browsers are supported by the barKoder Web SDK? #

The barKoder Web SDK will work on any browser that supports WebAssembly and ResizeObserver:

  • Desktop: Chrome 67+, Firefox 69+, Edge 79+, Safari 14+ (macOS), iOS Safari 14+
  • Android mobile: Chrome 67+, Firefox 79+, Samsung Internet 9.0+ and Opera 47+
  • iOS mobile: Safari 14+ (macOS), Chrome, Firefox, Edge

On the following pages you will find a summary of the support across most used browsers by version: 

8.How does the barKoder SDK licensing work? #

The barKoder Mobile SDK will register only the devices which successfully initialize and scan at least a single barcode from within your mobile or web application.

Note that uninstalls/reinstalls or the app on the same device will not consume additional device licenses from your license pool.

With standard tracking license the device queries the tracking server based on the callback (cb) parameter. This parameter is typically set to 15 days from the call, so devices with standard licenses usually record events every 15 days. If the device doesn't call for 15 days, an additional 15 days are added (amounting to 30 days) before the device starts returning unlicensed results.

To "renew" the license, the device MUST establish an internet connection and query the licensing server within 30 days.

Otherwise, the results will be unlicensed, even if the on-device license hasn't expired yet.

Decode counts are updated when the SDK's initialization function is called, but only periodically (whenever the device callsback our tracking server), thus the count is not always precise if the SDK hasn't contacted our licensing servers.

It is recommended that your app should only initialize the SDK when the scanning functionality is actually needed. But even for cases where it is initialized elsewhere, i.e. on app startup, then a device license will only temporarily consume a device license.

Zero decode device licenses will be cleared once every 24 hours.

The barKoder Web SDK on the other hand registers only the devices which use the scanner to successfully decode at least one barcode. Web apps are limited to a browser, so instead of devices we actually count unique browser clients. If an end-user opens the web app in two different type browsers, say Chrome and Firefox, it will be registered as two counts. If the device uses several Chromium-based browsers (say Chrome and Edge) it will not consume additional licenses for each different Chromium-based browser session.

9. I can't scan my barcode. Why is that? #

  • The symbology of a particular barcode must be enabled within the demo app and/or the barKoder SDK in order for it to be successfully scanned;
  • Make sure that the sample is not too small or severely damaged;
  • That your equipment meets the minimum requirements, see FAQ #6.
  • If you still can't scan the barcode after validating the above, don't hesitate to contact us, or just utilize the Ticketing System of the barKoder Developer Portal.

10. Is it possible to capture data from documents that contain a MRZ (Machine Readable Zone) code instead of a barcode? #

Yes, we have included MRZ Scanning features in our barKoder SDK as well as in the apps available on both the Play Store and the App Store. You can also utilize our MRZ Web Demo if you want to try the barKoder Web version of the MRZ scanner.

11. Does the app or the SDK store any personal information? #

No! We don’t store any information that is retrieved from scanning a barcode from a document or elsewhere. Please read our Privacy Policy. 

Page Contents

Type into the search box