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 simple samples that show you how use various features of the Scandit Data Capture SDK.

Here’s a list of our available samples on the Web:

Run the Samples

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

  1. 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:

await SDCCore.configure({
  licenseKey: "-- ENTER YOUR SCANDIT LICENSE KEY HERE --",
  ...
});

  1. Install the dependencies:

npm install

  1. Build the sample:

npm run build

  1. Serve the sample:

npm run serve

  1. Open http://localhost:8888 with your browser.

  2. You can use an SSH tunnel to access the running sample from another device via the internet. To do so, you can install ngrok <https://ngrok.com/> and create a tunnel to the running sample.

    Make sure you use the HTTPS tunnel because most of the browsers will deny permission to access the camera in non-secure contexts.

    ngrok http 8888

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

BarcodeCaptureViewsSample

Very simple example of setting up the library to scan barcodes.

Simple example of how to integrate a barcode scanner into your application.

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

IdCaptureExtendedSample

A simple examples of how to integrate ID Capture into your application.

An advanced example on how to scan different type of document with ID Capture.

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: