ZOLOZZOLOZDOCS

Manual Integration of ZOLOZ iOS SDK

This document introduces the complete process of manually integrating the ZOLOZ iOS SDK.

Prerequisites

Before integrating the ZOLOZ iOS SDK, ensure that your Xcode version is 15.0 or later.

Procedures

Step 1: Download SDK

  1. Open the zolozkit repository.
  2. Navigate to the Specs/zolozkit directory on the left, select the desired ZOLOZKit version (it is recommended to use the latest version), and open the corresponding zolozkit.podspec files.
    image
  3. In the zolozkit.podspec file, search for s.source, and download the SDK in ZIP format using the link provided in s.source.
    image
  4. After downloading, extract the ZIP file. The directory will contain multiple .framework files.
    image
  5. Delete unnecessary files:
    • Mandatory deletion: Remove APBToygerGarfield.framework and ZolozDoc.framework.
    • Optional deletion: If NFC functionality is not required, delete ZolozNfcReader.framework.

Step 2: Handling Resource Files

Move the following 5 .bundle files to the directory at the same level as the framework by following the path below.

copy
zolozkit.framework/ZolozKit.bundle
BioAuthEngine.framework/BioAuthEngine.bundle
ToygerServiceAlgo.framework/ToygerService.bundle
WebContainerLite.framework/WebContainerLite.bundle
ZolozNfcReader.framework/ZolozNfcReader.bundle

Note: If NFC functionality is not required, delete the ZolozNfcReader.bundle file.

The result is as shown in figure:

image

Step 3: Importing SDK into Main Project

  1. Drag the prepared SDK folder into your Xcode project.
    image
    image
  2. Open Target > General > Frameworks,Libraries,and Embedded Content, and verify that Xcode has automatically added references to these frameworks.image

Step 4: Adding System Libraries Required by ZOLOZKit

  1. In the zolozkit.podspec file, search for s.frameworks and s.libraries.
    image
  2. Add all libraries listed in s.frameworks and s.libraries to Target > General > Frameworks,Libraries,and Embedded Content one by one.

Step 5: Setting Compilation and Linking Parameters

Add the following linker flags in Target > Build Settings > Other Linker Flags:

copy
-ObjC
-ld64

image

Verify Integration Result

Verify Framework Integration

Add the following test code, if the metainfo string is retrieved successfully, the SDK integration is confirmed.

copy
//Reference hummer
#import <hummer/hummer.h>


//Test calling [ZLZFacade getMetaInfo]
NSString *metainfo = [ZLZFacade getMetaInfo];

image

Verify the Resource Files Integration

Add the following test code, if the retrieved path is not nil, it indicates that the SDK's resource files have been successfully integrated.

copy
//Verify that ZolozKit.bundles exist in the root directory
NSString * path = [[NSBundle mainBundle]pathForResource:@"ZolozKit" ofType:@"bundle"];

image.png