How to Integrate the ASAP SDK with your iOS app
This document pertains explicitly to help widgets created using the updated new ASAP Setup.
Please note that if you are using an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your App, use the latest ASAP iOS SDK 4.0. For older ASAP setups, you can use the ASAP iOS SDK 3.0.16.Please follow either of the following two methods to perform these steps.
I CocoaPods Integration
Add the Zoho Desk Portal SDK to the Podfile and install the SDK in your project.
1. First, include the SDK of your choice in the Podfile.
a. To integrate the ASAP Core SDK (Tickets, Knowledge Base, Community), include the following code in the do block of the Podfile.
- pod 'ZohoDeskPortalCore'
b. To integrate the ASAP Chat Kit SDK(Guided Conversation, Answer Bot, Business Messaging) with the ASAP Core SDK, include the following code in the do block of the Podfile.
- pod 'ZohoDeskPortalCore'
pod 'ZohoDeskPortalCore/ZohoDeskPortalChatKit'
c. To integrate the ASAP SalesIQ SDK(Chat) and ASAP Core SDK, include the following code in the do block of the Podfile.
- pod 'ZohoDeskPortalCore'
pod 'ZohoDeskPortalCore/ZohoDeskPortalSalesIQ'
2. Save the Podfile.
3. Execute the pod install or pod update command in Terminal.
To learn more about CocoaPods, read how to use CocoaPods.
II Manual Integration
1. Download the SDK of your choice.
a. ASAP Core SDK (Tickets, Knowledge Base, Community, and Guided Conversations)
2. Decompress the zip file you downloaded. Next, drag and drop the respective framework file with the extension .XCFramework to the Frameworks, Libraries, and Embedded Content section of your Xcode project bundle.
a. ASAP Core SDK (Tickets, Knowledge Base, Community, and Guided Conversations)
2. Decompress the zip file you downloaded. Next, drag and drop the respective framework file with the extension .XCFramework to the Frameworks, Libraries, and Embedded Content section of your Xcode project bundle.
If you choose to integrate the ASAP Core SDK, make sure to add the below four keys in the info—plist file of your app.
1 NSPhotoLibraryUsageDescription
2 NSCameraUsageDescription
3 NSMicrophoneUsageDescription
4 NSLocationWhenInUseUsageDescription
1 NSPhotoLibraryUsageDescription
2 NSCameraUsageDescription
3 NSMicrophoneUsageDescription
4 NSLocationWhenInUseUsageDescription
How to initialize the SDK on your iOS App
Once the SDK integration is completed, you must initialize the ASAP SDK on your app.
The following three keys are crucial for the initialization:
• Org ID
• App ID
• Data Center
The values of these keys will appear under the Install your widget on a website or mobile app section on the ASAP help widget setup page in Zoho Desk.
To initialize the SDK in your app, perform the following 2 steps:
1. Import the Zoho Desk Portal APIKit framework into the AppDelegate file in your project.
Swift
- import ZohoDeskPortalAPIKit
Objective-C
- @import ZohoDeskPortalAPIKit;
2. Paste the following initialization code into the application method with the didFinishLaunchingWithOptions argument.
Swift
- func application(_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions:
[UIApplicationLaunchOptionsKey: Any]?) -> Bool
{
ZohoDeskPortalKit.initialize(orgID: <#String#>, appID: <#String#>, dataCenter: <#ZDPDataCenter#>)
return true
}
Objective-C
- - (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
[ZohoDeskPortalSDK
initializeWithOrgID:<#NSString#>appID:<#NSString#>dataCenter:<
#ZDPDataCenter#>];
return YES;
}
Data Centers (DCs), according to the deployment types:
CN - ZDPDataCenter.CN
EU - ZDPDataCenter.EU
US - ZDPDataCenter.US
IN - ZDPDataCenter.IN
AU - ZDPDataCenter.AU
JP - ZDPDataCenter.JP
CN - ZDPDataCenter.CN
EU - ZDPDataCenter.EU
US - ZDPDataCenter.US
IN - ZDPDataCenter.IN
AU - ZDPDataCenter.AU
JP - ZDPDataCenter.JP
SA - ZDPDataCenter.SA
CA - ZDPDataCenter.CA
CA - ZDPDataCenter.CA
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Introducing ASAP iOS SDK
This document pertains explicitly to help widgets created using the updated new ASAP Setup. Please note that if you are using an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your App, use the latest ...How to Integrate the ASAP SDK with React Native
After successfully setting up the ASAP SDK on your mobile application, the next step is to integrate it. Please follow either of the following method to perform these steps. For Android applications, this step involves the use of Maven. The ASAP SDK ...Introducing ASAP React Native SDK
Equipping the Help Center services as widgets to deliver instant assistance to your customers The ASAP SDK for Android/iOS provides easy access to help your mobile app's end users. Using this SDK, you can create and customize a help widget within ...Introducing ASAP Flutter Apps SDK
Equipping the Help Center services as widgets to deliver instant assistance to your customers The ASAP SDK for Android/iOS provides easy access to help your mobile app's end users. Using this SDK, you can create and customize a help widget within ...Working with the ASAP SDK for Flutter
The ASAP SDK provides easy-to-use code snippets that "effortlessly integrate Help Center Components" with your Flutter application, including the following: • Knowledge Base: Provide users with easy access to articles and FAQs, enabling them to find ...
New to Zoho LandingPage?
Zoho LandingPage Resources