Wildlink API for iOS

Features

This repository allows you to integrate the following Wildlink functionality into your Swift iOS application.

• Create vanity URLs
• Query your personal commission information
• Query our merchant database
• Search for a specific merchant by name or ID

Requirements

• iOS 10.0+
• Xcode 10.2+

Installation

CocoaPods

You can use CocoaPods to install Wildlink by adding it to your Podfile:

use_frameworks!
platform:ios, '10.0'


target 'Wildlink_Example' do
  pod 'Wildlink', '~> 1.0.6'
end

Once you've added the cocoapod, run pod install to set up your project and open your .xcworkspace in Xcode

Manually

1. Download and drop Wildlink/Classes/*.swift in your project.
2. Congratulations!

Usage example

Initialize the SDK

Somewhere in your application (We suggest in your AppDelegate:didFinishLaunchingWithOptions function) you need to call the initialize method on the SDK and set yourself up as the Wildlink delegate:

Wildlink.shared.delegate = self
Wildlink.shared.initialize(appId: "<yourAppID>", appSecret: "<yourAppSecret", wildlinkDeviceToken: "<existingUserToken>", wildlinkDeviceKey: "<existingUserKey>")

A Note On Callbacks

In order to avoid blocking the main UI thread, Wildlink utilizes an internal processing queue to handle server responses. Completion handlers may be called on any thread, so if you're updating a UI element with the contents of a callback, be sure to wrap the UI calls in the main thread:

DispatchQueue.main.async {
    self.urlOutlet.text = url.absoluteString
}

Full example AppDelegate implementation

import UIKit
import Wildlink

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.

        //initialize wildlink
        Wildlink.shared.delegate = self
        let defaults = UserDefaults.standard
        Wildlink.shared.initialize(appId: "<yourAppID>", appSecret: "<yourAppSecret>", wildlinkDeviceToken: defaults.string(forKey: "wildlinkDeviceToken"), wildlinkDeviceKey: defaults.string(forKey: "wildlinkDeviceKey"))

        return true
    }

    ...

}

extension AppDelegate : WildlinkDelegate {
    func didReceive(deviceKey: String) {
        let defaults = UserDefaults.standard
        defaults.set(deviceKey, forKey: "wildlinkDeviceKey")
    }

    func didReceive(deviceToken: String) {
        let defaults = UserDefaults.standard
        defaults.set(deviceToken, forKey: "wildlinkDeviceToken")
    }

    func didReceive(deviceId: UInt64) {
        let defaults = UserDefaults.standard
        defaults.set(deviceId, forKey: "wildlinkDeviceId")
    }
}

In the above example, you'll notice that we're using NSUserDefaults to store and retrieve the device tokens and keys returned by Wildlink as part of conforming to the WildlinkDelegate protocol. Other requests from the Wildlink SDK are handled via completion handlers as shown below.

Request things from the SDK

Once you've initialized the SDK to identify your application and register the device it's running on, you can begin making requests.

Request a Vanity URL

import Wildlink
Wildlink.shared.createVanityURL(from: url) { (url, error) in
    // do something interesting with the result
}

// Alternatively, you can pass the URL directly
Wildlink.shared.createVanityURL(from: URL(string: "https://wildfire-corp.com")!, { (url, error) in
    // do something interesting with the result
})

Request your commission statistics

import Wildlink
Wildlink.shared.getCommissionSummary({ (stats, error) in
    // do something interesting with the result
})

Get details about a specific merchant

import Wildlink
Wildlink.shared.getMerchantBy("5476062", { (merchant, error) in
    // do something interesting with the result
})

Search our merchant listings

import Wildlink
//this example lists *all* of our merchants
Wildlink.shared.searchMerchants(ids: [], names: [], q: nil, disabled: nil, featured: true, sortBy: nil, sortOrder: nil, limit: nil, { (merchants, error) in
    // do something interesting with the result
})

Contribute

We would love for you to contribution to Wildlink, check the LICENSE file for more info.

Meta

© Copyright 2019 Wildfire Systems, Inc.

Distributed under the MIT license. See LICENSE for more information.

https://github.com/wildlink/wildlink-api-ios