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

Install the Android core library for the user app

The core library of Zoho Creator's Android SDK allows you to create custom UI and build an Android app using the data present in your Creator application.

1. Prerequisites

  • The latest version of Android Studio

2. Register your Android app with Zoho

  1. Edit your Zoho Creator application.
  2. Navigate to its Settings page.
  3. Click Mobile SDK under Developer Tools.
  4. Under the For Users section, click For Android. A pane will slide in from the right.
  5. Select the Core library.
  6. Click the Generate Client Credentials. This will generate the client ID and client secret for the Android app that you want to integrate with your Creator application.
  7. Downloaded the file, then add it to your project's raw folder: "<your_project_folder>/app/src/main/res/raw". (Create a folder named raw in this location if it doesn't exist)

3. Install the Android core library for the user app

Note:The Android app must have a minimum SDK version 22 or higher.
  1. Integrate SDK with your Android app:
    1. Add the Zoho maven repository URL in app/build.gradle:
      allprojects {
            repositories {
                  maven {
                             url ''
      Note:While adding the repository URLs in build.gradle you may encounter Build was configured to prefer settings repositories over project repositories issue. To proceed further, you need to add the repository URLs in settings.grade.
    2. Integrate Zoho Creator Core Library & Authentication Library in app/build.gradle
      dependencies {
            implementation 'com.zoho.creator:creator-core:1.4'
            implementation ''
    3. Click Sync Now in the bar that appears in the IDE.
  2. Configure your project with the following code:
    1. Add the below string in the strings.xml of your app:
      <string name="c_id"> GENERATED CLIENT ID </string>
      <string name="c_secret"> GENERATED CLIENT SECRET ID </string>
      <string name="redir_url"> REGISTERED REDIRECT URI</string>
      <string name="accounts_url"></string>
    2. In the oncreate method in your application / activity class, Initialize the Accounts SDK as follows:
      ZohoSDK.getInstance(this).init(scopes, showlogs);
      • scopes - "aaaserver.profile.READ,zohocontacts.userphoto.READ,ZohoContacts.contactapi.READ,
        Note: The scope list have been updated for version 1.4 and above.
      • showLogs - To show debug logs or not
    3. Create an Activity called HandleRedirectActivity and add the following code in its oncreate method:
    4. Add the following code to the AndroidManifest.xml file:
      <activity activity android:name=".HandleRedirectActivity" android:exported="true">
                  <action android:name="android.intent.action.VIEW" />
                  <category android:name="android.intent.category.DEFAULT" />
                  <category android:name="android.intent.category.BROWSABLE" />
                  <data android:scheme="<REDIRECTURI_WITHOUT_COLON_AND_SLASH>" />
    5. To open the login screen, add the below code snippet:
      val sdk = ZohoSDK.getInstance(applicationContext)
      if (!sdk.isUserSignedIn) {
         sdk.presentLoginScreen(this, object : ZohoTokenCallback {
            override fun onTokenFetchInitiated() {
            override fun onTokenFetchComplete(zohoToken: ZohoToken?) {
               // This method will be called after user logged-in successfully
            override fun onTokenFetchFailed(zohoErrorCodes: ZohoErrorCodes?) {
               // This method will be called if any error occurred in the login. You will receive the error code in this callback.
         }, null)
      } else {
         // Start intent to your first activity
    6. Implement the Creator Authentication interface ZCOauthHelper as follows:
      class ZCAuthImpl(private val context: Context) : ZCOauthHelper {
          override suspend fun getAccessToken(): String? {
              return ZohoSDK.getInstance(context).token.token
          override fun isUserSignedIn(): Boolean {
              return ZohoSDK.getInstance(context).isUserSignedIn
          override fun getUserData(): Any? {
              return null
          override fun getTransformedUrl(url: String): String {
              return url
          override fun checkAndLogout(): Boolean {
              return ZohoSDK.getInstance(context).checkAndLogout()
      override fun isEnhanceTokenNeeded(scope: String): Boolean {
              return false
          override fun enhanceToken(tokenHelper: ZCOauthHelper.ZCOAuthTokenHelper) {
    7. Add the following code to your application's / activity's oncreate method to set the instance of Authentication interface to the Creator SDK:
    8. Initialize ZohoCreator SDK in your application's / activity's oncreate method:


  1. I'm getting merge conflicts while generating a build. How to resolve them?
    Please add tools:replace="android:allowBackup" under the application tag in the AndroidManifest.xml file and try again.
  2. I get the "Duplicate class" error. What should I do?
    To resolve this error, you'll need to add android.enableJetifier=true in file
  3. I get the "Duplicate class androidx.lifecycle.ViewModelLazy found in modules jetified" error. What should I do?
    To resolve this error, please add implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.0' to your dependency list


Still can't find what you're looking for?

Write to us: