Add the SDK to Your App

This guide shows you how to add the Scandit Data Capture SDK to current existing project.

Prerequisites

  • The latest stable version of Capacitor and other related tools and dependencies.

  • A project with minimum iOS deployment target of 11.0 or higher. Or an Android project with target SDK version 21 (5.0 Lollipop) or higher.

  • A valid Scandit Data Capture SDK license key. You can sign up for a free test account at ssl.scandit.com.

Note

Android devices running the Scandit Data Capture SDK need to have a GPU or the performance will drastically decrease.

Get a License Key

  1. If you don’t have a Scandit account yet, create a free test account at ssl.scandit.com.

  2. Sign in to your account at ssl.scandit.com/sessions/new.

  3. Select “License Keys” from the left-hand menu.

  4. If you don’t have a license key for your app yet, click “Create native SDK license key” and enter the bundle ID for your project.

  5. Copy the license key.

If you have a paid subscription, please reach out to support@scandit.com if you need a new license key.

Add the SDK

Currently we support adding the Scandit Data Capture SDK Capacitor plugins to your project in two ways. The simplest way is to use the npm registry, alternatively you can manually download the plugins and add them to your project.

Note

You should always make sure to add the scandit-capacitor-datacapture-core plugin, as all other plugins depend on it.

1. Create a new project (optional)

If you do not have a Capacitor project yet that you’ll use, you should create a new one.

> npx cap init
> npx cap add ios
> npx cap add android

2a. Add the Scandit Data Capture SDK from the npm registry

To add our plugins from the npm registry, you can run these commands from your project’s root folder. In the following snippet we’re adding ScanditBarcodeCapture API

yarn add scandit-capacitor-datacapture-core
yarn add scandit-capacitor-datacapture-barcode

Note

You can also specify a version @<version>.

2b. Add the Scandit Data Capture SDK manually

After you download the archive containing all the plugins at ssl.scandit.com/sdk, unzip the archive. It includes the available Capacitor plugins, including the scandit-capacitor-datacapture-core plugin that all other plugins depend on.

First add scandit-capacitor-datacapture-core plugin:

yarn add <path to scandit-capacitor-datacapture-core plugin>

Once this is done, you can continue with adding the plugin for your desired functionality, e.g. for barcode capture, add the scandit-capacitor-datacapture-barcode plugin:

yarn add <path to scandit-capacitor-datacapture-barcode plugin>

3. Update the project

After adding the plugins, you’ll want to make sure they’re added to your project properly:

# iOS
> npx cap sync

# Android
> npx cap update android
> npx cap sync

Additional Information

  • When using the Scandit Data Capture SDK you will want to set the camera as the frame source for various capture modes. The camera permissions are handled by the plugins, so you don’t need to specify anything explicitly.

Next steps

You are now ready to tackle the following guides: