Skip to content

juspay/hyperswitch-sdk-ios

Repository files navigation

Hyperswitch iOS SDK

Usage

pod 'hyperswitch-sdk-ios'

Subspecs

pod 'hyperswitch-sdk-ios/scancard'
pod 'hyperswitch-sdk-ios', :subspecs => ['subspec1', 'subspec2']

This repository hosts the essential components of the Hyperswitch SDK iOS, it is a submodule repo for hyperswitch-client-core, in order to complete the setup please clone hyperswitch-client-core and follow the instruction given in the README.

Configuring Local Development Environment

The following table outlines the available configuration variables, their values, and descriptions:

Key Value Description
HyperswitchSource LocalHosted Load the bundle from the Metro server
HyperswitchSource LocalBundle Load the bundle from a pre-compiled local bundle

HyperswitchSource defaults to LocalHosted.

Note: To run the SDK on a physical iOS device, ensure that your Mac and the iOS device are connected to the same Wi-Fi network. Additionally, you'll need to provide your Mac's IP address as the value for the HyperswitchSourceIP key, as shown in the following table:

Key Value
HyperswitchSourceIP 10.0.0.1

Replace 10.0.0.1 with your actual Mac's IP address.

How to set variables

During local development, you may need to set specific variables to configure the SDK's behavior. You can set these variables using Xcode, command line interface (CLI), or any text editor.

Xcode

Project > Targets > Info Custom iOS Target Properties

CLI

Alternatively, you can leverage the plutil command to modify the Info.plist file directly from the terminal. For example, to set the HyperswitchSource variable, execute the following command:

plutil -replace HyperswitchSource -string "LocalBundle" Info.plist

Info.plist is present in hyperswitch directory.

Text Editor

If you prefer a more manual approach, you can open the Info.plist file in a text editor and add or modify the required keys and their corresponding values. For instance:

<key>HyperswitchSource</key>
<string>LocalHosted</string>
<key>HyperswitchSourceIP</key>
<string>10.0.0.1</string>

Integration

Get started with our iOS 📚 integration guides

Licenses