This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version.

Prerequisites

• Xcode IDE 26.0 (Required for latest SDK version 4.1.1-beta26.0)
• iOS 15 or above
• CocoaPods
  

Note:

1. If your Mac is powered by Apple Silicon (M1, M2, etc.), it is recommended to run Xcode with Rosetta enabled, as simulator support in Xcode is currently available only via Rosetta destinations.
   
2. It is recommended to use the latest SDK version to ensure compatibility and access to the newest features. CocoaPods installs the latest stable version by default. To use a specific or earlier version, specify it explicitly in your Podfile.
   
   For the list of supported SDK versions and compatible Xcode versions, refer here.

Register your iOS app with Zoho

Registering your iOS app with Zoho generates a  Client ID  and  Client Secret  combination. These are required to allow your iOS app to integrate with your Creator application. To register your iOS app with Zoho:

1. Navigate to Mobile section on the left pane and click the SDK  tab.
2. Click on the required row of the iOS app for which you want to configure the UI framework. The For Customer - SDK  pane opens on the right.
   

   

3. Click Generate Client.
   

   

4. This will generate the Client ID, Client secret, Portal ID,  and RedirectURI  for the iOS app that you want to integrate with your Creator application.
   

   

5. Downloaded the ZCAppInfo.plist file and add it to your project.

   

Install the iOS UI framework for the customer app

1. Install the Zoho Creator SDK using Pod:
   
   Add the pod specs to a pod file:
   
   target 'Demo' do
   use_frameworks!
   pod 'ZohoPortalAuth'
   pod 'ZCUIFramework'
   end
   post_install do |installer|
   installer.generated_projects.each do |project|
   project.targets.each do |target|
   target.build_configurations.each do |config|
   config.build_settings['CODE_SIGNING_ALLOWED'] = 'NO'
   config.build_settings['IPHONE_DEPLOYMENT_TARGET'] = '13.0'
   end
   end
   end
   end
2. Add the following to your Objective-C bridging header:
   

    #import <ZohoPortalAuthKit/ZohoPortalAuth.h> 

3. Import ZCUIFramework to use Zoho Creator's iOS UI framework:
   

   import ZCUIFramework
   

4. Configure your project with the following code, for example in the SceneDelegate file:
   

   class SceneDelegate: UIResponder, UIWindowSceneDelegate {
    var window: UIWindow?
   
     func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
      if let windowScene = scene as? UIWindowScene {
       let window = UIWindow(windowScene: windowScene)
      }
      let scope = ["aaaserver.profile.READ","zohocontacts.userphoto.READ","ZohoContacts.contactapi.READ","ZohoCreator.meta.CREATE","ZohoCreator.meta.READ","ZohoCreator.meta.UPDATE","ZohoCreator.meta.DELETE","ZohoCreator.data.CREATE","ZohoCreator.data.READ","ZohoCreator.data.UPDATE","ZohoCreator.data.DELETE","Stratus.stratusop.READ","ZohoCRM.modules.READ","ZohoCRM.users.READ"]
      let clientID = "<Your Client ID>"
      let clientSecret = "<Your Client Secret>"
      let portalId = "<Your Portal id>"
      let urlScheme = "<Your Url Scheme>"
      let accountsUrl = "https://accounts.zohoportal.com" //enter the accounts URL of your respective DC. For eg: EU users use 'https://accounts.zohoportal.eu'.
      ZohoPortalAuth.initWithClientID(clientID, clientSecret: clientSecret, portalID: portalId, scope: scope, urlScheme: urlScheme, mainWindow: self.window!, accountsPortalURL: accountsUrl)
   
      // To verify if the app is already logged in
   
      ZohoPortalAuth.getOauth2Token {
       (token, error) in
       if token == nil {
        // Not logged in
        self.showLoginScreen()
       } else {
        // App logged in already.
        // Ensure to use the following line of code in your iOS app before you utilize any of Creator SDK’s methods
        Creator.configure(uiDelegate: self)
       }
      }
     }
   
    func scene(_ scene: UIScene, openURLContexts URLContexts: Set <UIOpenURLContext> ) {
     if let context = URLContexts.first {
      let _ = ZohoPortalAuth.handleURL(context.url,
       sourceApplication: context.options.sourceApplication,
       annotation: context.options.annotation)
     }
    }
   }
   
   extension SceneDelegate: ZCUIServiceDelegate {
    func oAuthToken(with completion: @escaping AccessTokenCompletion) {
     ZohoPortalAuth.getOauth2Token {
      (token, error) in
      completion(token, error)
     }
    }
    func openURL(for openURLTasks: [OpenUrlTask]) {
     // Get Call back here when openurl have query string "zc_MobileSDK_HandleOpenURL=true"
    }
   }

   
   
   Code to allow Zoho Portal login to your iOS app:
   

    func showLoginScreen() {

    ZohoPortalAuth.presentZohoPortalSign( in: {
     (token, error) in
     if token != nil {
      //login success
     }
    })
   }

   
   
   Code to provision logout from Zoho Portal:
   

   func logout() {
    ZohoPortalAuth.revokeAccessToken {
     (error) in
     if error == nil {
      //Logout Successfully
     }
     else {
      //Error Occurred
     }
    }
   }

5. Add values for the following keys in  ZcAppInfo.plist . These are mandatory parameters for Apple's privacy compliance because their respective services are used in the UI framework.
   
   'NSCameraUsageDescription', 'NSContactsUsageDescription', 'NSLocationWhenInUseUsageDescription', 'NSMicrophoneUsageDescription', 'NSPhotoLibraryUsageDescription' and 'NSPhotoLibraryAddUsageDescription'