Skip to main content

Getting Started

Scantrust iOS SDK is the native SDK for the Scantrust Scan Engine.

The SDK offers the management of the camera, the image processing of the incoming frames and other features includes some utility functions.

Installation

  1. Copy and Paste all the necessary header and lib files to your project and don’t forgot to check App target

  2. Add the below frameworks into your xCode project:

    • libSTAuthenticate.a
    • libconv.tbd
    • UIKIT.framework
    • Foundation.framework
    • CoreGraphics.framework
    • AVFoundation.framework
    • QuartzCode.framework
    • SystemConfiguration.framework
  3. Depending on how you set up your project, the standard c++ library may or not be included by default.

  4. If you are using swift as the development language, you need to import the framework’s headers into the bridging header file:

#import <STAuthenticate/STCameraManager.h>`
#import <STAuthenticate/STLimitedCameraManager.h>`

Prerequisites

To authenticate or scan the secure QR codes there are some limits, only the iPhones which has higher quality iSight camera can scan the secure QR codes. For other iPhones, iPads and iPods the SDK will work like a normal QR code reader and it will give the scanned QR code URL/Text back. To get to know more about compatible phones please check this link or use the SDK utility method to identify current device is compatible for authenticating Scantrust code or not.

  • Minimum deployment target as iOS 8.0 and above.

  • In order for SDK to work, the following device permissions are required:

    • Camera: NSCameraUsageDescription To scan QR codes
    • Location: NSLocationWhenInUseUsageDescription Location is required to find out where you are
  • SDK will make network requests to Scantrust backend, so add the host names under App Transport Security Settings in Info.plist

  • Camera preview view must be full screen excluding the navigation bar and status bar