OkHi on your iOS app

The suite of OkHi iOS framework that will enable you to start collecting and verifying your user's addresses.

OkCollect and OkVerify supports iOS 10 and above

Prerequisites

OkHi Client Key and Branch Id

First you need to obtain your OkHi client key and branch ID. You can get these by signing up here.

Use your sandbox keys while you test and develop, and your production mode keys before you publish your app.

Installation

Both OkCollect and OkVerify requires you to add OkCore dependency. Add Swift Package dependency:

https://github.com/OkHi/core-xcframework.git

Configure your app

OkCollect

OkCollect requires access to the user's location in order to create an address at their current location. To satisfy this requirement add the following to your info.plist file and provide an useful description as to why your application needs access to the user's location

<key>NSLocationWhenInUseUsageDescription</key>
<string>String that explains why you need this permission</string>

OkVerify

If you're going to use both OkCollect and OkVerify AlwaysAndWhenInUseUsage location permission is required in order to verify the user. Modify your info.plist file to include the NSLocationAlwaysAndWhenInUseUsageDescription key as well as the NSLocationWhenInUseUsageDescription

<key>NSLocationWhenInUseUsageDescription</key>
<string>String that explains why you need when in use location permission</string>
<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>String that explains why you need always location permission</string>

Location Updates Background Mode Capability

OkVerify obtains verification signals in the background, to enable this make sure to add "Location updates" at Background Modes under Signing & Capabilities of your target