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 14.1
• iOS 11 or above
• CocoaPods
  

Note: M1 Mac users should run Xcode with Rosetta enabled.

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 core framework. The  For Customer - SDK  pane will open 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 core framework for the customer app

1. Install the Zoho Creator SDK using Pod:
   
   target 'Demo' do
   use_frameworks!
   pod 'ZohoPortalAuth'
   pod 'ZCCoreFramework'
   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'
   end
   end
   end
   end
2. Add the following to your Objective-C bridging header:
   

   #import <ZohoPortalAuthKit/ZohoPortalAuth.h> 

3. Import ZCCoreFramework to use Zoho Creator's SDK's iOS core framework:
   

   import ZCCoreFramework

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 must 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(delegate: 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: ZCCoreFrameworkDelegate {
    func oAuthToken(with completion: @escaping AccessTokenCompletion) {
     ZohoPortalAuth.getOauth2Token {
      (token, error) in
      completion(token, error)
     }
    }
   }

   
   
   Code to add 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
     }
    }
   }

FAQ

References

Related Topics

• Understand mobile SDK for iOS
• Configure push notifications

Users

• Core framework for iOS
  
• UI & Core framework for iOS

Customers

• UI & Core framework for iOS