ScanTrust iOS SDK

Version: 1.3.0.alpha

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

Contents

1. Installation
2. Getting Started
   1. Prerequisites
3. STCameraManager Setup And Management
   1. Setup
   2. STCameraManager Handling
   3. Results
4. StLimitedCameraManager Setup and Management
   1. Setup
   2. StLimitedCameraManager Handling
   3. Results
5. Utilities
   1. STPhoneManager

Installation

• Copy and Paste all the necessary header and lib files to your project and don’t forgot to check App target
• Add the below frameworks into your xCode project
  • libSTAuthenticate.a
  • libconv.tbd
  • UIKIT.framework
  • Foundation.framework
  • CoreGraphics.framework
  • AVFoundation.framework
  • QuartzCode.framework
  • SystemConfiguration.framework
• Depending on how you set up your project, the standard c++ library may or not be included by default.

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>`

Getting Started

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

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 <key>NSCameraUsageDescription</key> <string>To scan QR codes</string>
  • Location <key>NSLocationWhenInUseUsageDescription</key> <string>Location is required to find out where you are</string>
• 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

STCameraManager Setup And Management

The entry point of the ScanTrust Processing is the STCameraManager, this class does all the heavy lifting, setting up the camera and the preview (view finder) view, running the image processing on the incoming frames and reporting the various outcomes.

Setup

The manager class is a singleton and provides easy way to setup and start the camera with preview view.

In viewWillAppear() method, call setUpCameraSessionWithPreview: error: to setup the preview view and initialize the camera object.

#import <STAuthenticate/STCameraManager.h>

@implementation ViewController
#pragma mark - View life cycle methods
- (void)viewWillAppear:(BOOL)animated {
    [super viewWillAppear:animated];
    NSError *error;
    // Considering you have UIView called preview setup in storyboard/XIB or in code
    [STCameraManager sharedInstance] setUpCameraSessionWithPreview:previewView error:error];
}
@end

SDK does provides STPreviewView to setup the camera preview in Storyboard or create a new instance.

STCameraManager Handling

The sharedInstance camera manager provides following method to control the camera and it is up to the user to determine when to start and stop the camera or processing. But in general the camera is started in the onResume() method and stoped on onPause()

- (void)onResume {
  [STCameraManager sharedInstance] setCameraTorchModeOnOff: YES];
  [STCameraManager sharedInstance] startScanning];
}

- (void)onPause {
  [STCameraManager sharedInstance] setCameraTorchModeOnOff: NO];
  [STCameraManager sharedInstance] pauseScanning];
}

Results

The results are organized as follows:

Report Types: Define the states of the flow

Scan States: Define the states of the individual scans

The scan states are distributed among the report types as shown in the following figure and table

Camera manager does provide below delegate methods to know the result during ScanTrust image processing. STScanState is a enum and matches the above Scan State table

@protocol STCameraManagerDelegate <NSObject>
@optional
- (void)cameraManager:(STCameraManager *)cameraManager didProcessFrameWithScanState:(STScanState)scanState;
@end

didProcessFrameWithScanState notifies the delegate when there is a camera frame processed and have a defined Scan State

StLimitedCameraManager Setup and Management

The StLimitedCameraManager does the same camera and preview view setup as the STCameraManager but does not perform the image and frame processing required for the ScanTrust authentication. It is limited to checking the ownership of the code based on its content.

Setup

By default It will enable the reading of 1D barcodes (UPC-A, UPC-E, EAN-8, EAN-13, Code 39, Code 93, Code 128, ITF(Interleaved Two of Five), RSS 14, RSS EXPANDED) and QR codes and it’s instantiation should be done in the same way as for the STCameraManager.

StLimitedCameraManager Handling

The manager gives access to the same methods as the STCameraManager

Results

The results obtained with the StLimitedCameraManager are:

Limited Camera manager provides a delegate method to know the result.

@protocol STLimitedCameraManagerDelegate <NSObject>
@optional
- (void)cameraManager:(STLimitedCameraManager *)cameraManager didCompleteScanWithScanResult:(STScanResult *)scanResult;
@end

STScanResult class gives the scanned code data and STScanState

Utilities

STPhoneManager

The STPhoneManager is a compatibility manager and a utility class that is used to assess the phone’s state/compatibility in relation to

• ScanTrust’s Secure Graphic authentication (isPhoneSupported)
• Request/check access to camera (requestPersmissionForCamera and isAuthorizedForCamera)
• Device details like model, Name, OS and version

© 2017 ScanTrust, SA