Connect iOS SDK

The Connect iOS SDK allows you to embed Finicity Connect anywhere you want within your own mobile applications.

Compatibility

The Connect iOS SDK supports the following iOS versions:

  • iOS 11 or later

Download the SDK

Step 1—Add the SDK to your project

Import Connect into your code.

Example:

.import connect

Step 2—Create callback functions

Create callback functions for loaded, done, cancel, and error events. These callbacks correspond to events in Connect’s data flow.

Sample
 func connectLoaded() {
self.connectNavController = UINavigationController(rootViewController: self.connectViewController)
self.connectNavController.modalPresentationStyle = .fullScreen
self.present(self.connectNavController, animated: false)
}
Callbacks
loaded
Called when the Connect web page is loaded and ready to display.
doneCalled when the user successfully completes the Connect application. It also has an unlabeled NSDictionary? parameter containing event information.
cancelCalled when the user cancels the Connect application.
errorCalled when an error occurs while the user is using the Connect application. The unlabeled NSDictionary? parameter contains event information.
routeCalled with the user is navigating through the screens of the Connect application. The unlabeled NSDictionary? parameter containing event information.
userConnect 2.0 (only)
Called when a user performs an action. User events provide visibility into what action a user could take within the Connect application. The unlabeled NSDictionary? parameter contains event information.

Step 3—Create a ConnectViewConfig Object and ConnectViewController Class

  • 1

    Using a valid Connect URL and callback functions, create a ConnectViewConfig object.
    See Generate 2.0 Connect URL APIs.

  • 2

    Create an instance of the ConnectViewController class, providing the ConnectViewConfig class when calling its load method.

  • 3

    In the loaded callback, present the ConnectViewController using a UINavigationController with the ConnectViewcontroller as its rootViewController.

  • 4

    The ConnectViewController automatically dismisses when the Connect flow is completed, canceled early by the user, or when an error occurred. 

Sample
 func openConnect(url: String) {
let config = ConnectViewConfig(connectUrl: url, loaded: self.connectLoaded, done: self.connectDone, cancel: self.connectCancelled, error: self.connectError, route: self.connectRoute, userEvent: self.connectUserEvent)

self.connectViewController = ConnectViewController()
self.connectViewController.load(config: config)
}
func connectLoaded() {
self.connectNavController = UINavigationController(rootViewController: self.connectViewController)
self.connectNavController.modalPresentationStyle = .fullScreen
self.present(self.connectNavController, animated: false)
}
func connectDone(_ data: NSDictionary?) {
// Connect flow completed
}

func connectCancelled() {
// Connect flow exited prematurely
}

func connectError(_ data: NSDictionary?) {
// Error encountered in Connect flow
}

func connectRoute(_data: NSDictionary?) {
// Connect route changed
}

func connectUserEvent(_ data: NSDictionary?) {
// Connect user event fired in response to user action
}