iOS SDK v1.2.1 (legacy)

🚧

This page documents SDK v1.2.1 (legacy)

This is the archived API reference for the pre-2.0 aerosync-ios-sdk line (installed via Xcode's "Branch: main" option, not a version tag). New integrations should use the current SDK — see iOS SDK for v2.2.1 docs, or Migrating from 1.x if you're upgrading an existing app.

Introduction

This iOS SDK provides an interface to load the Aerosync widget directly into your iOS app. To import it, use the Swift Package Manager.

1. Installation

To install the library you need to go to your general project settings. Then go to your Package Dependencies tab. Click on the "+". On the window that is opened, in the top right search bar paste the following link to the library repo:

https://github.com/Aeropay-inc/aerosync-ios-sdk.git

Set the dependency rule as Branch and the branch as main. When done, click Add Package.

Go back to your general project settings and go to the Target for your project, then the General tab. Scroll to Frameworks, Libraries and Embedded Content to make sure the library was added there as well. If not, click the "+" and find it in the directories.

Xcode sometimes takes a while to find the package and fully include it in your project, so you can restart Xcode if needed.

2. Usage/Examples

The iOS Aerosync SDK is brought into the project as a separate View through a NavigationLink. You can attach the widget to any component that will allow navigation.

In the following example a basic Text field is attached to the navigation link that will open the widget.

import Foundation
import SwiftUI
import aerosync_ios_sdk

struct AerosyncWidgetView : View {
    @EnvironmentObject var appVM : AppViewModel
    var body: some View{
        NavigationStack{
            NavigationLink{
                AerosyncSDK(
                 token: "...",
                 env: "sandbox",
                 deeplink: "aerosync:connect",
                 consumerId: "",
                 theme: "light", // "light" or "dark"
                 onEvent: self.onEvent,
                 onSuccess: self.onSuccess,
                 onClose: self.onClose,
                 onLoad: self.onLoad,
                 onError: self.onError,
                 handleMFA: false,
                 userId: "",
                 jobId: ""
                 )

            } label: {
                VStack {
                    Image(systemName: "globe")
                        .imageScale(.large)
                        .foregroundStyle(.tint)

                    Text("Aerosync SDK Test")
                    Button("Connect") {
                        // action to connect to Aerosync
                        print("Connect")
                    }
                }
                .padding()
            }
        }
    }
    func onEvent(message: Any) {
        print("onEvent Callback \(message)")
    }
    func onSuccess(message: Any) {
        print("onSuccess Callback \(message)")
    }
    func onClose(message: Any) {
        print("onClose Callback \(message)")
    }
    func onLoad(message: Any) {
        print("onLoad Callback \(message)")
    }
    func onError(message: Any) {
        print("onError Callback \(message)")
    }
}

The AerosyncSDK widget takes in an env parameter, a token parameter, a deeplink, and callback event notifications needed for your implementation. To generate a token, check out our integration guide.

Each callback returns a message that comes back from the widget based on the messages received by it.

📘

The deeplink parameter is a required field that links back to your iOS application for the best OAuth authentication experience.

The largest FIs in the US use OAuth experiences to authenticate their end users' banks for the optimal user experience in a secure manner.

To implement deeplinking on iOS, refer to the official iOS Deeplink guide for Universal Links here. The URL scheme method can also be used.

Theme Support

The SDK supports both light and dark themes. You can customize the appearance by setting the theme parameter:

// Light theme (default)
AerosyncSDK(
    token: "your-token",
    env: "sandbox",
    deeplink: "yourapp://connect",
    theme: "light",
    // ... other parameters
)

// Dark theme
AerosyncSDK(
    token: "your-token",
    env: "sandbox",
    deeplink: "yourapp://connect",
    theme: "dark",
    // ... other parameters
)

If no theme is specified, the widget defaults to the light theme.

Store Connected Account

Store the onSuccess() callback return to authenticate with the AeroSync API to retrieve account information.

{
  "payload": {
    "ClientName": "client3",
    "user_id": "a2c7f64f-3df9-4090-b3bd-ad6fc3003c90",
    "FILoginAcctId": "{\"u_guid\":\"USR-701a457e-5b93-4598-b7a1-b968c495ee3f\", \"m_guid\": \"MBR-d699c457-90f7-4b96-96c1-c50a445eabec\", \"a_guid\": \"ACT-9f5549d6-e402-43f4-8351-cd4018de7a80\"}",
    "user_password": "735e33b9-78ec-4887-99d7-a3056997ceb9"
  },
  "type": "pageSuccess"
}