Skip to main content

How to: Build Integration

Follow this guide to include the iOS Client SDK in your app's dependencies.

Prerequisites​

You must have an API key and access to Hiya's private GitHub repository which hosts the SDK.

Start here to request an API key and access to the private SDK repository from Hiya.

Build Requirements​

Hiya recommends Xcode 16.3 or later when integrating the ClientSDK with a host application.

Step 1: Installing Hiya SDK​

Swift Package Manager​

Swift Package Manager is the preferred tool for automated distribution of Swift code and is integrated into the Swift compiler.

To install the Hiya SDK using Swift Package Manger follow the steps below:

From Xcode​

  1. Select File > Swift Packages > Add Package Dependency. Enter https://github.com/hiyainc-partners/iOS-ClientSDK in the "Choose Package Repository" dialog.
  2. In the next page, specify the version resolving rule as Up to Next Major with 2.0.0, or select branch/main.
  3. After Xcode has checked out the source and resolved the version, you can choose the HiyaClientSDK library and add it to your application and extension targets.

CocoaPods​

If your project already uses CocoaPods, you can also install the Hiya SDK via CocoaPods by adding the following to your Podfile:

pod 'HiyaClientSDK', :git => 'https://github.com/hiyainc-partners/iOS-ClientSDK.git'

Notes​

All targets using the SDK, including each call directory target, will need to include this pod:

platform :ios, '12.0'
use_frameworks!

target 'SampleApp' do
    pod 'HiyaClientSDK', :git => 'https://github.com/hiyainc-partners/iOS-ClientSDK.git'
end

target 'calldirectory' do
    pod 'HiyaClientSDK', :git => 'https://github.com/hiyainc-partners/iOS-ClientSDK.git'
end

Alternate Integration as a Local Dependency​

Alternatively, if the github repo is not available, you can add the package as a local dependency to your Xcode project by dragging the package folder into your project. For instructions, see this Apple article: [Editing a Package Dependency as a Local Package] (https://developer.apple.com/documentation/swift_packages/editing_a_package_dependency_as_a_local_package)

For more info, read Adding Package Dependencies to Your App from Apple.

Next Steps​

Once the Client SDK has been integrated with your app, proceed to the iOS ClientSDK: Enable Caller Id Guide to learn how to configure and enable Caller Id in your app.