Getting started with the iOS SDK

Set up Convertedin iOS SDK so you can start to Know what your customers do before and after visiting your offline stores. Leverage data and learn what their behavior looks like.

Requirements
The Convertedin iOS SDK requires Xcode 10.1 or later and is compatible with apps targeting iOS 13 or above.
Installation
The iOS SDK is compatible with apps supporting iOS 13 and above. Apps can be written using Swift.
Getting started with the iOS SDK requires a few steps :
1.
Adding pod 'ConvertedInSDK' to your podfile.
2.
Initialize the SDK with your secret key by import ConvertedIn   to your AppDelegate  file 
3.
Authenticate user by Sending user data for segmentation.
4.
Track user events
​
​
Step 1: Adding the dependency
Adding pod 'ConvertedInSDK' to your podfile, then execute pod install in terminal
1
    pod 'ConvertedInSDK'
Copied!
​
Step 2: Initialize the SDK
import Convertedin to your AppDelegate  file 
1
import 'ConvertedIn'
Copied!
then Initialize the 
- apikey
- secretkey
- applicationID
1
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { 
2
        // Override point for customization after application launch.
3
        pinofferInit.apikey = "MF4K33RX2JM6MSH6R66FH37TSCGJ"
4
        pinofferInit.secretKey = "e93ea6967d70cbbeb3d46a4554d58601"
5
        pinofferInit.ApplicationID = "com.Pinoffer.app1WithframeWork"
6
        
7
        return true
8
    }
Copied!
​
Step 3: Authenticate user by Sending user data for segmentation
1
      func createNewUser() {
2
        PinofferUser.getAuth()
3
        let dataUser = ConfigUserData()
4
        dataUser.id = "1114992092"
5
        dataUser.name = "ehab ali"
6
        dataUser.email = "[email protected]"
7
        dataUser.birthday = "1988-4-11"
8
​
9
        dataUser.gender = .male
10
​
11
        dataUser.countryCode = .EG
12
        dataUser.fcmToken = "FCM User Token"
13
​
14
        PinofferUser.setUserData(userData: dataUser)
15
    }
Copied!
​
Step 4: Track user events
We have around 14 events that need to be implemented to be logged across the user's life cycle within the app. Here are the events
​
launch App.
Sign in.
Sign up.
Sign out.
Cart view.
View item.
Add item to cart.
Remove an item from the cart.
Transaction confirmation.
Search.
Promo redeemed.
Feedback.
You need to log the user events across the app by adding each event as follows:
​
 launch App 
Implement this event in your AppDelegate  file  to log whenever the user opens the app as follows:
1
Events.luanchApp()
Copied!
Sign in
Implement this event after the user is successfully signed in as follows:
1
Events.signIn()
Copied!
Sign up
Implement this event after the registration or signing in for the first time as follows:
1
Events.signUp()
Copied!
Sign out
Implement this event after the user signs out as follows:
1
Events.signOut()
Copied!
Cart view
Implement this event whenever the user views the Cart and pass the cart id as follows:
1
Events.viewCart(cartID: "12")
Copied!
View item
Implement this event whenever the user views an item that can be added to the cart and pass the item id as follows:
1
Events.viewItem(itemID: "10")
Copied!
Add item to cart
Implement this event whenever the user adds an item to the cart and pass the cart id and the item id as follows:
1
Events.addItem(itemID: "10", cartID: "12")
Copied!
Remove item from cart
Implement this event whenever the user views the cart and pass the cart id as follows:
1
Events.removeItemFromCart(itemID: "10", cartID: "12")
Copied!
Transaction confirmation
Implement this event after the user successfully completes  payment and pass the order id and the cart id as follows:
1
Events.transactionConfirmation(cartID: "12", orderID: "09321")
Copied!
Search
Implement this event whenever the user searches for an item and pass the search query as follows:
1
 Events.search(query: "Running Shoes")
Copied!
Promo redeemed
Implement this event whenever the user redeems a promo code successfully and pass the promo string and it's valued as follows:
1
Events.promoRedeemed(promoCode: "100023312", amount: 99)
Copied!
Order feedback
If you have implemented a feedback activity or you take the user's feedback in any form just log it bypassing the order id and the feedback questions and answers as follows:
1
func feedbackx(){
2
      
3
        let fb = Setfeedback()
4
        fb.orderID = 1
5
        fb.note = "this is a note"
6
        fb.feedbackList = [
7
            feedBack(title: "Quality of the product", rate: 1),
8
            feedBack(title: "Quality of sales team", rate: 2),
9
            feedBack(title: "feed No 3", rate: 3),
10
            feedBack(title: "feed No 4", rate: 4),
11
            feedBack(title: "sfdfsd", rate: 5)
12
        ]
13
         Events.orderFeedback(feed: fb)
14
     
15
    }
Copied!
in the Feedback rate 
the number 1: mean very bad rate
the number 5: mean Excellent rate 

Android - Previous

Getting started with Android SDK

Next - WooCommerce

Getting Started

Last modified 9mo ago

Copy link

Contents

Requirements

Installation