Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 2.76 KB

README.md

File metadata and controls

56 lines (42 loc) · 2.76 KB
Raw

PILOT VERSION

This SDK is still in Pilot phase, please only use if you have a pilot agreement contract in place!

If you are looking for our recommended SDK then please head to Mobile Engage SDK

Contents

What is the Emarsys SDK?

The Emarsys SDK enables you to use Mobile Engage and Predict in a very straightforward way. By incorporating the SDK in your app, we support you, among other things, in handling credentials, API calls, tracking of opens and events as well as logins and logouts in the app.

The Emarsys SDK is open sourced to enhance transparency and to remove privacy concerns. This also means that you can always be up-to-date with what we are working on.

Using the SDK is also beneficial from the product aspect: it simply makes it much easier to send push messages through your app. Please always use the latest version of the SDK in your app.

Setup

1. Installation with CocoaPods

1.1 Install CocoaPods

CocoaPods is a dependency manager for iOS, which automates and simplifies the process of using 3rd-party libraries. You can install it with the following command:

$ gem install cocoapods

1.2 Podfile

To integrate the Emarsys SDK into your Xcode project using CocoaPods, specify it in your Podfile:

platform :ios, '11.0'

source 'https://github.com/CocoaPods/Specs.git'

target "<TargetName>" do
	pod ‘EmarsysSDK’, '~> 2.0.0’
end

Wherever you see or anything similar in <> brackets, you should change those according to your own naming convention.

1.3 Install Pods

After creating the Podfile, you need to execute the command below to download dependencies: pod install

2. Requirements

  • The iOS target should be iOS 11 or higher.
  • In order to be able to send push messages to your app, you need to have certifications from Apple Push Notification service (APNs).

Note

For further informations about how to use our SDK please visit our Documentation