Setting up the iOS SDK

Follow the steps below to setup the invitee sdk in your existing project.

Podfile

Install the invitee sdk & its dependencies

pod 'Invitee'

Info.plist

Add your api key & allow contacts access. If you haven’t generated an api key before, you can create from within the web dashboard

<key>NSContactsUsageDescription</key>
<string>Allow contacts so you can send invites</string>
<key>Invitee API Key</key>
<string>YOUR-API-KEY</string>

Setup a user

Calling setup user is the first step. You should call this as soon as a user is logged in. This will add a user to a campaign if one is available & fetch information about the campaign, which you can then show in your UI

private let user = User(customerId: "abcd-1234-abcd-1234", firstName: "John", lastName: "Appleseed", phoneNumber: "0412345678")

InviteeClient.shared.setup(for: user) { [weak self] maybeCampaign in
    guard let weakself = self, let campaign = maybeCampaign else { return }
    // show the referral information & a CTA to present the campaign overview page
}

Present campaign overview page

The campaign overview page shows information to a user about the current referral campaign they are in & allows them to send invites to their friends. The information seen on this page reflects what you have setup for that campaign in the web dashboard.

InviteeClient.shared.present(on: self) // where self is a UIViewController

Present referral notifications

When users signup both the referrer & referee can be notified about who of their friends signed up & what reward they earned. Call this on a UIViewController where you want to present these popups.

override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)
    InviteeClient.shared.presentNotificationIfNeeded()
}

Tracking referral steps

In order for Invitee to process referrals, you need to let us know when key ‘steps’ have been completed. These steps are configured when you setup a campaign & are used to indicate a completed referral. Eg. Sign up + make purchase = referral reward.

There are two ways to track these steps, either via our REST api or through the SDK itself. If you choose to use the SDK then the following code snippet can be used as a reference for tracking.

private let user = User(customerId: "abcd-1234-abcd-1234", firstName: "John", lastName: "Appleseed", phoneNumber: "0412345678")

InviteeClient.shared.trackReferralStep(user: user, step: "SIGNUP", completion: { [weak self] result in
    switch result {
    case .success:
        // Referral step successfully tracked!
    case .failure(let error):
        // Error occured while attempting to track step
    }
})