How to Integrate the ASAP SDK with your iOS app

How to Integrate the ASAP SDK with your iOS app

AlertThis document pertains explicitly to help widgets created using the updated new ASAP Setup.
InfoPlease 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.
  1. 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.
  1. 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.
  1. pod 'ZohoDeskPortalCore'
    pod 'ZohoDeskPortalCore/ZohoDeskPortalSalesIQ'
2. Save the Podfile.

3. Execute the pod install or pod update command in Terminal.
Notes
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.
Alert
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

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

  1. import ZohoDeskPortalAPIKit

Objective-C

  1. @import ZohoDeskPortalAPIKit;
2. Paste the following initialization code into the application method with the didFinishLaunchingWithOptions argument.

Swift

  1. func application(_ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions:
    [UIApplicationLaunchOptionsKey: Any]?) -> Bool
    {
    ZohoDeskPortalKit.initialize(orgID: <#String#>, appID: <#String#>, dataCenter: <#ZDPDataCenter#>)
    return true
    }

Objective-C

  1. - (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
    {
    [ZohoDeskPortalSDK
    initializeWithOrgID:<#NSString#>appID:<#NSString#>dataCenter:<
    #ZDPDataCenter#>];
    return YES;
    }
Notes
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
SA - ZDPDataCenter.SA
CA - ZDPDataCenter.CA

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        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 CRM Training
            Redefine the way you work
            with Zoho Workplace

              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 CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Intake FormsLegalMobile App
                              Form DesignerHRMobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsEncrypted Forms

                              Secure Forms

                              WCAG

                                      Create. Review. Publish.

                                      Write, edit, collaborate on, and publish documents to different content management platforms.

                                      Get Started Now






                                                        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.




                                                            Manage your brands on social media

                                                              Use cases

                                                              Make the most of Zoho Desk with the use cases.

                                                               
                                                                

                                                              eBooks

                                                              Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                               
                                                                

                                                              Videos

                                                              Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                               
                                                                

                                                              Webinar

                                                              Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                               
                                                                
                                                              • Desk Community Learning Series


                                                              • Meetups


                                                              • Ask the Experts


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner

                                                                Zoho Sheet Resources

                                                                 

                                                                    Zoho Forms Resources


                                                                      Secure your business
                                                                      communication with Zoho Mail


                                                                      Mail on the move with
                                                                      Zoho Mail mobile application

                                                                        Stay on top of your schedule
                                                                        at all times


                                                                        Carry your calendar with you
                                                                        Anytime, anywhere




                                                                              Zoho Sign Resources

                                                                                Sign, Paperless!

                                                                                Sign and send business documents on the go!

                                                                                Get Started Now




                                                                                        Zoho TeamInbox Resources





                                                                                                  Zoho DataPrep Demo

                                                                                                  Get a personalized demo or POC

                                                                                                  REGISTER NOW


                                                                                                    Design. Discuss. Deliver.

                                                                                                    Create visually engaging stories with Zoho Show.

                                                                                                    Get Started Now









                                                                                                                        • 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. Code block to installing the react-native plugin: We have the following list of plugins, customers can integrate the SDK based on their ...
                                                                                                                        • Introducing ASAP React Native SDK

                                                                                                                          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 React-Native SDK 3.0.0. You can use the ASAP React-Native SDK ...
                                                                                                                        • Introducing ASAP Flutter Apps SDK

                                                                                                                          This document pertains explicitly to help widgets created using the updated new ASAP Setup. 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 Flutter Plugin ...
                                                                                                                        • How to change your language settings for ASAP Flutter SDK?

                                                                                                                          The ASAP SDK is designed to accommodate a diverse user base, supporting a total of 49 languages. This flexibility allows you to select the most suitable language based on the geographical location of your app's end-users, ensuring a tailored ...
                                                                                                                          Wherever you are is as good as
                                                                                                                          your workplace

                                                                                                                            Resources

                                                                                                                            Videos

                                                                                                                            Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                            eBooks

                                                                                                                            Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                            Webinars

                                                                                                                            Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                            CRM Tips

                                                                                                                            Make the most of Zoho CRM with these useful tips.



                                                                                                                              Zoho Show Resources