Integrate iOS Application
Our DIY flow for iOS application integration simplifies onboarding and easily integrates application features quickly and efficiently. This lets you integrate our application features quickly and validate their functioning simultaneously.
The integration flow is categorized into four parts as follows:
- Setup: You create your application with basic information here.
- Integrate: You integrate your base SDK, enabling in-app messages and system event tracking.
- Add device: You can add Test devices to validate the correct integration of all the features in real time.
- Features: You can add and test all the available features for your application.
Log on to the Netcore CE dashboard and click Settings > Apps, which is the listing page for all your application assets.
Setup
Click the ADD NEW button to start integrating your application. A window opens, allowing you to select the target operating system for your application— Android or iOS.
![App Integration](https://files.readme.io/80d22e1-APP_IOS_INTEGRATION.gif)
Navigate to iOS App Setup Section
Provide the following information to setup iOS application:
Column Name | Description |
---|---|
App name | Provide a a name for your application. |
App Platform | Choose the platform on which your application is built (Android or iOS). Select iOS in this case. Note: Once you have save the platform, it cannot be changed later. |
Integrate
![Basic Integration for Netcore SDK](https://files.readme.io/37c73a8-Integrate_.gif)
Basic Integration for Netcore SDK
In this section, your unique APP ID are generated.
- Depending on the application platform selection, the steps to integrate the basic SDK are be listed along with its code snippets.
- As you complete each step, make sure to select Mark as done checkbox to confirm all the steps are followed and implemented correctly.
NOTE
Once you select Mark as done checkbox and moved to the next step, you cannot deselect them.
- Integration of basic SDK enable features such as In-app messages and System events tracking automatically.
Refer to the following to understand the SDK integrations:
Click Next to save the changes for integration section and and move to the next step.
Add device
Adding a test device enables you to validate your basic integration as well as all other features for the app. Click the ADD TEST DEVICE button to add a test device.
![Add a Test Device](https://files.readme.io/1a5a4fc-Add_device-_ios.gif)
Add a Test Device
In Deeplink Schema section provide a custom URL scheme for pairing your device as a test device. Follow the below steps to configure a custom URL scheme.
Provide the following information to add a test device:
Section | Instruction | Note |
---|---|---|
Name your test device | Identify and differentiate among other test devices by provide a name under Device Name for your test device before proceeding. | |
Ensure app is installed on your device | Click NEXT to generate a QR code and link. Open the link on the device you wish to use as a test device, after ensuring that the app is installed on it. Scan the QR code to proceed. Close and re-launch your app after scanning the code. | A confirmation message is displayed on the panel and on your device, indicating that the device has been added as a test device. The app and SDK version on the device will also be displayed. |
Device connection details | View your test device status. | If you receive an error message, retry a few times. If the error persists, it means that the basic SDK integration was not done correctly. Check the integration steps and try again to add a test device. |
Adding a test device is optional. You can skip this step and move directly to the "Features" section.
Features
![Available Features to Enable](https://files.readme.io/546082c-features_ios_app_.gif)
Available Features to Enable
In this section, you are able to see all the features that are available for your application.
In-app messages and System events tracking are in TEST mode as they get enabled automatically along with the base SDK integration. You can now directly test these two features here if you have added a test device in the previous section.
In-app Messages
To send a test in-app to your test device, click TEST on the in-app messages card.
If you have already integrated your test device then it appears in the drop-down list in the Select test device section. Select the devices you want to send the in-app message to and then click SEND TEST MESSAGE button. You need to close and re-launch your app to receive the test in-app message. A success or failure message is shown on the panel.
Refer here to know more about in-app messages.
System Events Tracking
In this section, you can interact with your application and perform different system events and validate them from this section.
Refer to Sample Events Sheet by business vertical.
Select the test device from the drop-down list in Select test device section. All system events perform from that device would be listed here along with the payloads under event value column. You can validate the date and time and the events performed from here to check if they are being tracked correctly. Under the Check dropped events section view the events that were dropped(if any).
Note
Events performed by test devices would be stored in the panel for only upto 2 days from the performed date.
App Push Notification
To enable this feature, you have to integrate the SmartPush SDK. Click the ENABLE button to view the steps for integration.
![App Push Notification](https://files.readme.io/6c1577b-image.png)
App Push Notification
Section | Description |
---|---|
Integrate APN | This step has a set of 6 sub-steps required to integrate the SmartPush SDK. More details on these steps are present in the document linked above. You need to check them all as 'Mark as done' once you have completed all of these steps to move ahead to the next step. |
Update FCM server key | In this step you need to add your FCM server key and you can also enable the Push amplification feature if interested, it is optional. |
Validate push notification | Now it's time to test the integration! If you have followed all the steps until now error-free then you should be able to send an test push notification to your test devices. You need to select the devices from the drop-down, click on 'SEND TEST NOTIFICATION'. You should receive an app push notification on your test device and a success message on the panel. |
Advanced (optional) | This section consists of other advance features such as custom sound and the steps to enable it. |
Disable APN | Switching on this toggle will disable the APN SDK. Please do not use this toggle unless absolutely necessary. |
Refer here to know more about App push notifications
App Inbox
You can enable App Inbox feature from here.
However please reach out to your Account manager, onboarding manager or Customer Service manager for this feature or send any email to our support team from the panel.
Refer here to know more about App inbox
Custom events tracking
In this section, you can interact with your application and perform different custom events and validate them from this section.
Refer to Sample Events Sheet by business vertical.
Select the test device from the drop-down list in Select test device section. All custom events perform from that device would be listed here along with the payloads under event value column. You can validate the date and time and the events performed from here to check if they are being tracked correctly. Under the Check dropped events section view the events that were dropped(if any).
![Custom Event Tracking](https://files.readme.io/f7a1e4d-image.png)
Custom Event Tracking
User tracking
Refer here for user tracking implementation steps.
Location tracking and Geofencing
You can enable location tracking as well as the geofence feature for your app by following these simple steps. Like all other features, you can also test its functioning using your test device. It shows the actual location of your test device if the integration is done correctly.
![Location Tracking and Geofencing](https://files.readme.io/0b3f44a-image.png)
Location Tracking and Geofencing
Refer here for Location tracking implementation.
Refer here to know more about Geofences.
Updated about 1 month ago