README.md

Kustomer Chat iOS SDK

Embed Kustomer in your own products with our chat SDK for iOS.

---

Documentation and guides

iOS Docs and guides

Kustomer Developer Portal

Requirements

• A Kustomer.com API Key (How to get an API key)
• Xcode 14.0+
• iOS 12.0+

Installation

Note: Starting with iOS version 2.6.0, the PubNub library is downloaded as a dependency if installing the SDK using the Swift Package Manager or Cocoapods.

Swift Package Manager

1. Create or open your project inside of Xcode
2. Navigate to File > Swift Packages > Add Package Dependency
3. Enter https://github.com/kustomer/kustomer-ios in the URL field
4. Use the Up to Next Major Version rule spanning from 2.0.0 < 3.0.0, and hit the Next button

Cocoapods

1. Add pod 'KustomerChat', :git => 'https://github.com/kustomer/kustomer-ios.git' to your Podfile
2. Run pod update or pod install on your project
3. Add the following to your Podfile, to update all Pods to the min target

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '12.0'
    end
  end
end

Post-Install

1. Add photo and camera privacy descriptions to your Info.plist.
2. In the application(_:didFinishLaunchingWithOptions:) method of your AppDelegate add

Kustomer.configure(apiKey: "API_KEY_HERE", options: nil, launchOptions: launchOptions)

3. Call Kustomer.show() whenever and wherever you want to open the Kustomer chat interface.

See Installation for a full guide.