Connect iOS SDK

Overview

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

The iOS SDK is distributed as a compiled binary in XCFramework format which allows you to easily integrate our SDK into your development projects. Our iOS SDK has full bitcode support so that you don’t have to disable bitcode in your applications when integrating with our SDK.

The XCFramework format is Apple’s officially supported format for distributing binary libraries for multiple platforms and architectures in a single bundle.

Additional documentation for the Connect iOS SDK can be found at docs.finicity.com/connect-ios-sdk

Requirements

The Connect iOS SDK supports iOS 11 or later.

Installation

Connect iOS SDK can be installed either with CocoaPods or by manually dragging the Connect.xcframework into your Xcode project.

CocoaPods

Connect iOS SDK can be installed as a CocoaPod. To install, include the following in your Podfile.

use_frameworks!

pod 'FinicityConnect'

Manual

1. Open your project in Xcode and drag the Connect.xcframework folder into your project.

2. In the build settings for your target, select the General tab, scroll down to the Frameworks, Libraries, and Embedded Content, and select Connect.xcframework. Under the Embed column, select Embed & Sign from the menu drop-down list if is not already selected.

Integration

1. Add import Connect into all your source files that make calls to the Connect iOS SDK.

import UIKit
import Connect

2. Create callback functions for loaded, done, cancel, error, route, and user events.
   These callbacks correspond to the following events in Connect's data flow:

   Event	Description
   loaded	Called when the Connect web page is loaded and ready to display.
   done	Called when the user successfully completes the Connect application. It also has an unlabeled NSDictionary? parameter containing event information.
   cancel	Called when the user cancels the Connect application.
   error	Called when an error occurs while the user is using the Connect application. The unlabeled NSDictionary? parameter contains event information.
   route	Called with the user is navigating through the screens of the Connect application. The unlabeled NSDictionary? parameter containing event information.
   user	Connect 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.

   Note: The done, error, route, and user callback functions will have a NSDictionary? parameter that contains data about the event.

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

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

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

6. The ConnectViewController automatically dismisses when the Connect flow is completed, cancelled early by the user, or when an error is encountered.

Example

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 = .automatic
    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
}

ConnectWrapper Swift Sample App

This repository contains a sample application ConnectWrapper written in Swift (requires Xcode 11 or greater) that demonstrates integration and use of Connect iOS SDK.