Getting Started

Requirements

  • Access to a workspace
  • Created Client API Key
    When creating the API key, you can use use allowlisting or denylisting to only allow the events you intend to use.
  • Recommended Environment:
    • Xcode 14
    • iOS SDK 16
  • Minimum Target Deployment: iOS 9.0+
  • Bitcode support: Yes
Important:
  • Support for iOS 9 and 10 will end soon and the minimum deployment target will change to iOS 11.
  • Support for bitcode will end soon.

Frameworks

The Synerise SDK references the following frameworks:

  • Foundation.framework
  • UIKit.framework
  • CoreGraphics.framework
  • SystemConfiguration.framework
  • MobileCoreServices.framework
  • CoreTelephony.framework
  • Security.framework
  • CommonCrypto.framework
  • WebKit.framework
  • UserNotifications.framework

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects.

If you don’t have CocoaPods installed yet and don’t know it, please start with CocoaPods - Getting Started.

  1. Once you have CocoaPods installed you should add dependency to Synerise SDK into your Podfile:

    use_frameworks!

target YOUR_PROJECT_TARGET do
  pod 'SyneriseSDK'
end
Note: From version 4.2.0, the Synerise SDK is distributed as XCFramework on CocoaPods.
  1. After that, execute the following shell command in directory depending on your project configuration: 
    pod repo update
pod install

Carthage

Carthage is simple, decentralized dependency manager for Cocoa projects.

If you don’t have Carthage installed yet and don’t know it, please start with Carthage project on GitHub.

  1. Once you have Carthage installed you should add dependency to Synerise SDK into your Cartfile:

    github "synerise/ios-sdk"

  2. Then, you should execute shell command in directory depending on your project configuration:

    carthage update

  3. Go to Xcode project target’s General section.

  4. Open <YOUR_XCODE_PROJECT_DIRECTORY>/Carthage/Build/iOS in Finder and drag SyneriseSDK.framework to Embedded Binaries.

  5. Make sure Copy items if needed is selected and click Finish.

Initialization

Setting up

  1. Go to Xcode project target’s General section, find Other Linker Flags property and add -ObjC flag.

  2. If you are going to use Push Notifications:

    • Go to Info.plist.
    • Add a row for Required background mode of type Array with App downloads content in response to push notifications or add code below directly:
    <key>UIBackgroundModes</key>
<array>
    <string>remote-notification</string>
</array>

  3. If you are going to use HTTP addresses (instead only HTTPS), you will need to change whitelist domains in your app by adding appropriate configuration to Info.plist.

    • You can add configured domain/domains that you need.
    • Give permission for all domains.
    <key>NSAppTransportSecurity</key>
<dict>
    <key>NSExceptionDomains</key>
    <dict>
        <key>yourdomain.com</key>
        <dict>
        <!--Include to allow subdomains-->
        <key>NSIncludesSubdomains</key>
        <true/>
        <!--Include to allow HTTP requests-->
        <key>NSTemporaryExceptionAllowsInsecureHTTPLoads</key>
        <true/>
        <!--Include to specify minimum TLS version-->
        <key>NSTemporaryExceptionMinimumTLSVersion</key>
        <string>TLSv1.1</string>
        </dict>
    </dict>
</dict>

    <key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key><true/>
</dict>

Import Synerise SDK

You will need to import Synerise SDK header into the files that contain code relating to SDK.

import SyneriseSDK
Note: In Objective-C, you can either include it in your Prefix Header (PCH) and Synerise SDK will be imported to all files automatically.

Basic Initialization

First of all, you need to initialize Synerise SDK and provide Client API Key.

You may initialize it wherever you need.

let clientApiKey = "YOUR_CLIENT_API_KEY"

Synerise.initialize(clientApiKey: clientApiKey) // 1
Synerise.setDebugModeEnabled(true) // 2
Synerise.setCrashHandlingEnabled(true) // 3
Synerise.setDelegate(self) // 3

Let’s dive into some configurable functionalities:

  1. Synerise.initialize(clientApiKey:) - initializes Synerise SDK.
  2. Synerise.setDebugModeEnabled(_:) - enables debug mode for Synerise SDK. See Debug logs section for more information.
  3. Synerise.setCrashHandlingEnabled(_:) - enables crash handling. Synerise SDK sends a crash event automatically when an uncaught exception occurs.
  4. Synerise.setDelegate(_:) - sets delegate to handle actions from Synerise SDK. See SyneriseDelegate section for more information.
Note: If you use Synerise hosted in Google Cloud (app.geb.synerise.com), you must initialize a custom API environment and use https://api.geb.snrapi.com as the baseUrl parameter.

Initialization with custom API environment

There is option to change API base URL for on-premise installations.

One thing you have to do for that is using different initialization method:

Synerise.initialize(clientApiKey: "YOUR_CLIENT_API_KEY", baseUrl: "YOUR_API_BASE_URL")

Advanced Initialization

This is an example of advanced initialization with:

  • custom API base URL for on-premise installations
  • debug mode enabled
  • crash handling enabled
  • most of settings options available
  • main delegate SNRSyneriseDelegate
  • Client’s state delegate SNRClientStateDelegate
Important: It is highly recommended to have settings configured when Synerise SDK is initialized, before invoking the Synerise.initialize(clientApiKey:) method. See SDK Settings section for more details about settings options.
Synerise.setDebugModeEnabled(true)
Synerise.setCrashHandlingEnabled(true)

Synerise.settings.sdk.enabled = true
Synerise.settings.sdk.appGroupIdentifier = "YOUR_APP_GROUP_IDENTIFIER"
Synerise.settings.sdk.keychainGroupIdentifier = "YOUR_KEYCHAIN_GROUP_IDENTIFIER"
Synerise.settings.sdk.minTokenRefreshInterval = 1800
Synerise.settings.sdk.shouldDestroySessionOnApiKeyChange = false

Synerise.settings.notifications.enabled = true
Synerise.settings.notifications.disableInAppAlerts = true
Synerise.settings.notifications.encryption = false

Synerise.settings.tracker.autotracking.enabled = true
Synerise.settings.tracker.autotracking.mode = AutoTrackMode.Fine
Synerise.settings.tracker.autotracking.excludedClasses = [SampleViewController.self]
Synerise.settings.tracker.autotracking.excludedViewTags = [0, 1, 2]

Synerise.settings.tracker.tracking.enabled = true

Synerise.settings.tracker.minBatchSize = 10
Synerise.settings.tracker.maxBatchSize = 100
Synerise.settings.tracker.autoFlushTimeout = 5.0
Synerise.settings.tracker.autoTracking.mode = .fine
Synerise.settings.tracker.locationAutomatic = true

Synerise.settings.injector.automatic = true

Synerise.initialize(clientApiKey: "YOUR_CLIENT_API_KEY", baseUrl: "YOUR_API_BASE_URL")

Synerise.setDelegate(self)
Client.setClientStateDelegate(self)
Injector.setWalkthroughDelegate(self)
Injector.setBannerDelegate(self)
Injector.setInAppMessageDelegate(self)

Debug Mode

You can enable debug logs for Synerise SDK by method Synerise.setDebugModeEnabled(_:).

WARNING: Do not use Debug Mode in a release version of your application.
Synerise.setDebugModeEnabled(true) // Enables logging for all modules

You can receive some logs about:

  • Core: push notifications
  • Tracker: autotracking events, declarative events, sending process
  • Client: customer state, authorization
  • Injector: campaigns, UI
  • Promotions: promotions, vouchers
  • Content: content widget, documents, recommendations

Synerise SDK Delegate

You can handle Synerise SDK initialization result by two methods:

  • snr_initialized() - This method is called when Synerise is initialized.
  • snr_initializationError(error:) - This method is called when an error occurs while Synerise initialization.

You can specify your custom action when a customer clicks on simple push, banner or walkthrough. Synerise SDK implements two main actions that customer may invoke - open URL and Deeplink:

  • snr_handledAction(url:) - This method is called when Synerise handles URL action from campaign activities.
  • snr_handledAction(deepLink:) - This method is called when Synerise handles deeplink action from campaign activities.
  • snr_handledAction(url:activity:completionHandler:) - This method is called when Synerise handles URL action from campaign activities.
  • snr_handledAction(deepLink:activity:completionHandler:) - This method is called when Synerise handles deeplink action from campaign activities.
Note: For more information about handling actions from Synerise SDK, see Campaigns section.

There is also another method, that invokes when Synerise SDK needs re-registration for push notifications:

  • snr_registerForPushNotificationsIsNeeded() - This method is called when Synerise needs registration for Push Notifications.
Note: For more information about notifications, see Push Notifications section.

Other SDK Delegates

For more information about SDK delegates, see SDK Delegates section.

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker