Run our Sample Apps

The best way to start working with the Scandit Data Capture SDK is to run one of our sample apps. In this guide we will go through the available apps and how to run them.

Available Samples

We have created both simple and advanced samples that show you how use various features of the Scandit Data Capture SDK. The simple samples allow you to get going quickly, while the advanced samples show you how to use additional settings and setup the scanner for the best user experience.

Here’s a list of our available samples on Capacitor:

Run the Samples

Before you can run a sample app, you need to go through a few simple steps:

  1. Sign in to your Scandit account and download the newest Capacitor plugins at ssl.scandit.com/dashboard/sign-in. Unzip the archive and go to the samples folder.

  2. Set the license key. To do this, sign in to your Scandit account and find your license key at ssl.scandit.com/dashboard/sign-in.

Once you have the license key, add it to the sample that you’d like to run:

Scandit.DataCaptureContext.forLicenseKey('-- ENTER YOUR SCANDIT LICENSE KEY HERE --')

  1. Install the dependencies for the sample.

> yarn install
> yarn build

# iOS
> npx cap sync

# Android
> npx cap update android
> npx cap sync

  1. Run the sample. We recommend running the samples on a physical device as otherwise no camera is available.

> npx cap open ios
# or
> npx cap open android

Note

You probably need to setup signing for iOS.

New! Pre-built Barcode Scanning Component Samples

Scandit offers building blocks that can be integrated in just a few lines of code. The pre-built camera UI has been designed and user-tested to achieve superior process efficiency, ergonomics and usability.

BarcodeSelectionSimpleSample

BarcodeSelectionSettingsSample

Basic sample that uses the Barcode Selection API.

Demonstrates how you can adapt the barcode selection settings best to your needs and experiment with all the options.

Fully-customizable API: Single Scanning with Barcode Capture Samples

The Barcode Capture API offers developers a high level of flexibility with unlimited options for designing your own UI and workflow. You can use these samples as a starting point. We recommend that you familiarize yourself with our Best Practices for Usability to learn what to consider when using the Fully-customizable API.

BarcodeCaptureSimpleSample

Basic sample that uses the camera to read a single barcode.

Fully-customizable API: MatrixScan Samples

The Barcode Tracking API offers developers a high level of flexibility with unlimited options for designing your own UI and workflow. You can use these samples as a starting point. We recommend that you familiarize yourself with our Best Practices for Usability to learn what to consider when using the Fully-customizable API.

MatrixScanSimpleSample

MatrixScanBubblesSample

Very simple sample which shows how you can highlight barcodes on screen with the Scandit Data Capture SDK.

Demonstrates the use of more advanced augmented reality use cases with the Scandit Data Capture SDK.

ID Scanning and Verification Samples

-IdCaptureSimpleSample

A basic ID Capture setup to scan front of ID Cards and barcodes from AAMVA documents.

Text Capture Samples

TextCaptureSample

A basic Text Capture setup to recognize GS1 and LOT and integrate the parser.

All our samples can be found in the archive that can be downloaded from our dashboard. Check the following section for more details.

Next steps

You are now ready to tackle the following guide: