Install the SDK on iOS

In this guide, you will learn how to get started with the Genius Scan SDK for iOS.

Overview

The SDK for iOS is provided as a binary iOS framework GSSDK.xcframework. The framework exposes different levels of abstractions depending on the path you choose to integrate the Genius Scan SDK in your app.

You can choose to use the higher-level Scan Flow, which abstracts away much of the complexity and provides the fastest integration. Alternatively, you can integrate individual UI components and call image processing routines to have more control over your user experience. These two different integration paths are described in more detail in the overview.

Sample code

We provide two iOS demo projects as part of the SDK:

• GSSDKSimpleDemo demonstrates how to start a simple scan flow and its various customization options.
• GSSDKCustomDemo demonstrates a custom integration of the SDK. You will also see how to manually perform OCR on the scanned document, as well as how to generate a PDF file.

Demo app

You can test the scan flow of the Simple integration, including all config options and data extraction features, by installing our demo app from TestFlight.

Size of the SDK

The SDK framework file used during development may seem large, but it includes slices for all device architectures (arm64, x86_64) and debug symbols. When deployed on your users’ devices, the impact is much smaller.

The table below shows the approximate impact of the SDK on your app’s size. The download size represents the increase in your app’s size when downloaded by users. The installed size represents the size of the SDK once installed on the user’s device.

Because the Genius Scan SDK is provided as a dynamic framework placed in your app’s bundle, the App Store’s delta update logic will skip downloading it if you update your app without updating the Genius Scan SDK.

Setup

Integrating the framework

Manually

Drag and drop GSSDK.xcframework into the Frameworks, Libraries and Embedded Content of your app’s target.

With Swift Package Manager

In your Xcode project, under Package Dependencies, add a new dependency on the Genius Scan SDK https://github.com/thegrizzlylabs/geniusscan-sdk-spm and select the GSSDK product.

1. Select your Project and click on ‘+’ to add a Package:
2. Type in the URL of the Genius Scan SDK Swift Package repository: https://github.com/thegrizzlylabs/geniusscan-sdk-spm, select the package and click ‘Add Package’:
3. Select the target that will use the SDK:

With CocoaPods

⚠️ The CocoaPods integration isn’t recommend as CocoaPods is being deprecated globally.

If you already use CocoaPods, you can use the Genius Scan SDK as a Pod. Add the following line to your existing Podfile (Make sure you specify the correct SDK location):

pod 'GSSDK', :podspec => 'https://s3.amazonaws.com/tgl.geniusscan.sdk/GSSDK-5.15.0.podspec'

Import the SDK

import GSSDK

Configure your app

Your app will need the user’s permission to access the camera. You must specify the reason for requesting this permission by adding the NSCameraUsageDescription key to your Info.plist file.

What’s Next?

Next, configure a license key.