Kaizen #116 - Client Types in Zoho API Console

Kaizen #116 - Client Types in Zoho API Console

Hello everyone!
Welcome back to another post in the Kaizen series!

This week, we will discuss different client types available in Zoho API Console, and when to use each.

When you register an app in Zoho API Console, you typically choose a client type based on how your application interacts with Zoho services.
Let us discuss the available client types and how authorization is handled for each.

Available client types

  1. Server-based
  2. Client-based
  3. Self client
  4. Non-browser-based
  5. Mobile-based

1. Server-based

If you have a web-based application that runs on a dedicated HTTP server and interacts with Zoho services by calling Zoho APIs via that server, you must register your app with this client type.
This client type is for applications that redirect the users to another URL on a web browser to authorize themselves, where they give consent to your application to use their data.
In other words, you must use this client type when you have a front-end web UI and require user intervention before your app can access user data via the dedicated server.

Consider that you are developing a web-based custom application. Users authorize that app via browser to allow their Zoho CRM data to be accessed and used by that application.
During the registration process in Zoho API Console, you would choose the "Web-based" client type.
OAuth 2.0 would be used for user authentication, allowing your app to securely access and interact with Zoho CRM data on behalf of the users.

Here is a gist of what happens:
  1. Users visit your website where you have the Login with Zoho button.
  2. When a user clicks it, that user will be redirected to accounts.zoho.com with the details of your app such as client ID, scope, redirect uri, access type as the URL parameters.
  3. Your app must make an API call to Zoho Accounts with the client ID, scope, redirect uri, and access type. Users are shown the data that your application wants to use.
  4. When users give their consent, Zoho redirects them back to your app.This will be the "Redirect URL" you give while registering your app.
  5. The redirect URL will have the authorization code(grant token) as one of the parameters, along with the location(user's domain).
  6. Your app must then make API calls from your web server to Zoho Accounts to generate access and refresh tokens with the generated grant token.
  7. You must store these tokens in your DB to access that user's data in Zoho CRM. While making API calls, you must send this access token in the header.
  8. Your app must also have the logic to regenerate access tokens from refresh tokens when the access token expires.
Note that your app must take care of storing user's details like email, organization ID, and tokens.

The following image shows the protocol flow.


You can use any of our server-side SDKs to simplify this process.
When you use our SDK, all you have to do is, generate the grant token and initialize the SDK with the client details and this token. The SDK takes care of access token generation, refreshing it, and token storage.


For more details, you can refer to the Accounts guide and CRM help doc.

2. Client-based applications

This client type is for applications that do not have a server and run exclusively on a web browser.
This is also called the Implicit flow as your app makes API calls to Zoho only when users are using your app.
This type of application loads data dynamically on the webpage, and accesses Zoho CRM data by making API calls via Javascript.

Consider the same example where there is a Login with Zoho button on your webpage.
Here is a gist of what happens when a user clicks it.
  1. Your app redirects the user to Zoho Accounts.
  2. Your app makes the authorization request with the client ID, redirect uri, scope, and response type as token.
  3. The user is shown the data that your webpage would use.
  4. When the user gives consent, Zoho Accounts sends the access token to the redirect uri as a parameter, along with the expiry time and the location of user's data in Zoho's accounts server.
  5. You can include the "email" in your scope parameter in the access token request to get user's information. The response will have a parameter called id_token that will be in the header.payload.signature format. You need to decrypt the payload section of the parameter using the base-64 decryption algorithm to get user information.
  6. Your app must then make API calls to Zoho with this access token to fetch data.
  7. When the access token expires, your app must take care of regeneration and storage.


As the API calls are made from your domain to a different domain(zohoapis.com), for security reasons, the browser will throw the CORS error. So, your domain will be registered while registering your app, and Zoho will know to allow the API calls made from that domain.

As the tokens are available on the browser itself, we recommend handling them with care.
When you use our client-side JS SDK, it automatically generates a new access token upon expiry.

3. Self Client Applications

When your application does not have a redirect URL or a UI, but performs only a backend job, and does not need user intervention, then you must choose this client type.

A self client is often used when the application and Zoho services are operated by the same entity, and you want to enable secure communication between them. For example, you have an internal reporting tool and integrate it with Zoho Analytics. In this case, both the tool and Zoho Analytics are operated by the same entity.
Similarly, consider that you have a legacy product management system and want to perform data sync between Zoho CRM and the system, then you must use the self client.

Here is a gist of what happens.
  1. You register your app as self client in Zoho API Console.
  2. You will get the client details such as ID and secret.
  3. You provide the scopes required for your app to access CRM data.
  4. You will receive the grant token.
  5. Your app must then make API calls to Zoho Accounts to generate access and refresh tokens.
  6. Your app can then use this access token to make API calls to Zoho CRM and use data.
You can refer to our older Kaizen post on this topic for more details.
Note that self client apps can also use any of our server-side SDKs. As already said, the SDK takes care of access and refresh token generation, refreshing the access token, and token storage.

4. Non-browser applications

This client type is for devices that do not have a user agent such a web browser. A TV, for instance.
Let us consider an example involving a smart TV application that integrates with Zoho ShowTime. In this scenario, the smart TV application acts as a non-browser client.
Here is how authentication is handled:
  1. You must register your smart TV app in Zoho API Console with the type "Non-browser application".
  2. Users install a dedicated Zoho ShowTime application on their smart TVs.
  3. When users launch the Zoho ShowTime application on their smart TV, they are prompted to authenticate with their Zoho ShowTime account.
  4. When they successfully authenticate, Zoho Accounts sends the grant token to your app, along with the user-code, device-code and verification URL,The user must go to this verification URL on a browser and enter the user-code to grant permission to the app.
  5. Meanwhile, your app must poll the accounts server using the grant token to check if the token has been received.
  6. When the user enters the user code, Zoho Accounts sends the access token to your app.
  7. Your app can then use the access token to make API calls to Zoho. Your app must take care of token storage and renewals.

Here is the protocol flow. For more details, refer to this doc.


5. Mobile-based applications

You must use this client type when you have developed an app exclusively for mobile devices. The protocol flow is similar to server-based application where a browser session is required for the users to authenticate.



Similar to server-side apps, mobile apps also need to handle redirection, token generation and storage.
If you use any of our Mobile SDKs, the SDK itself handles token generation and storage.

We hope you found this post useful. Let us know your thoughts in the Comment section or write to us at support@zohocrm.com.


Cheers!


      Zoho Campaigns Resources


        • Desk Community Learning Series


        • Digest


        • Functions


        • Meetups


        • Kbase


        • Resources


        • Glossary


        • Desk Marketplace


        • MVP Corner


        • Word of the Day


        • Ask the Experts


          Zoho CRM Plus Resources

            Zoho Books Resources


              Zoho Subscriptions Resources

                Zoho Projects Resources


                  Zoho Sprints Resources


                    Zoho Orchestly Resources


                      Zoho Creator Resources


                        Zoho WorkDrive Resources



                          Zoho CRM Resources

                          • CRM Community Learning Series

                            CRM Community Learning Series


                          • Tips

                            Tips

                          • Functions

                            Functions

                          • Meetups

                            Meetups

                          • Kbase

                            Kbase

                          • Resources

                            Resources

                          • Digest

                            Digest

                          • CRM Marketplace

                            CRM Marketplace

                          • MVP Corner

                            MVP Corner




                            Zoho Writer Writer

                            Get Started. Write Away!

                            Writer is a powerful online word processor, designed for collaborative work.

                              Zoho CRM コンテンツ




                                ご検討中の方

                                  • Recent Topics

                                  • Automate pricebook per customer

                                    Example Scenario: I want to create a customer package (Silver Package, Gold Package, Platinum Package) and associated it with a Price Book that contains discounted prices for certain products. When a customer assigned to this Silver Package places an

                                  • Document Tracking

                                    Hi all Zoho crmplus user here. I am migrating from hubspot and in Hubspot when my sales team email a document they can see when the client has opened the document and how many minutes they sepend on it. This persists for additional openings and readings

                                  • Apply partial payments to invoices from the Banking Module

                                    We need this! Why is this not possible?

                                  • Forecast UI improvements

                                    Hi I have two improvement requests for the UI in the Forecast function. Can you add the ability to reorganise the Pipeline, Committed and Best Case columns on the Forecast? I thought they were in alphabetical order, so we renamed them so that we could

                                  • Missing services/ features / buttons

                                    Hello, 1. I can't locate the DKIM information in ZoHo CRM that I need to add as txt strings to our DNS in GoDaddy. 2. In other activities I cannot locate the 'Help' button for context senstivie help 3. I wish to merge two records into a single record

                                  • [Free Webinar] Building Data Relationships Using Lookup Fields - Creator Tech Connect

                                    Hello Everyone! We welcome you all to the upcoming free webinar on the Creator Tech Connect Series. The Creator Tech Connect series is a free monthly webinar that runs for around 45 minutes. It comprises technical sessions in which we delve deep into

                                  • Episode I : Exploring the World of Custom Functions in Zoho Desk

                                    Hello Again! Welcome to an Automation Adventure in the World of Zoho Desk Join us on a journey to explore how custom functions can enhance and extend the capabilities of Zoho Desk. Automation is everywhere. From robotic arms assembling products on factory

                                  • Free Webinar - Overview of Zoho Sign and latest updates- May 2025

                                    Hello there! What's the digital alternative to endless paperwork? Zoho Sign. Designed for digital-first businesses, Zoho Sign is a complete digital signature solution with powerful features and seamless integrations that streamline your entire workflow.

                                  • Multiple Forecast configurations

                                    Hi all Is it possible to have multiple Forecast Configurations? That is, not just multiple forecasts, but rather different forecasts assigned to different configurations? The use case here is that we currently have the Forecast module configured for Revenue

                                  • Discussions from Ask The Experts 19: Inside Zoho Desk Spring Release 2025 : Zia in Focus

                                    Hello everyone, We had insightful discussions in both the sessions of Ask the Experts(ATE) 19, diving deep into engaging conversations around Zia and the spring release. Your enthusiastic participation and thought-provoking questions brought the sessions

                                  • Basic campaign set-up

                                    I have been trying hard to get Zoho CRM and Zoho Mail connected, but somewhere I seem to have wires loose in my brain. I'm not winning. Could anyone just show me (1) how to set up a scheduled email campaign (test to only six internal staff), (2) how to

                                  • Add template Categories Qoutes sendmale

                                    Is there other way to add other template categories in sendmail qoute?

                                  • Report categories not appearing in pie chart

                                    I have created a simple report to display all of the accounts in our CRM in a certain region, broken down by their 'account type' field. I have displayed this data as a donut chart Highlighted in red in the top left, you can see there are a total of 968

                                  • Asking for the implementation roadmap or step-by-step guide

                                    Hello everyone, I'm a freelancer who's been hired to implement Zoho CRM for a client, and I want to make sure I approach this correctly. Could someone kindly share a comprehensive implementation roadmap or step-by-step guide that covers all the essential

                                  • Sort By Date - Deluge

                                    I have the following code, which normally works to sort calls by created time. Every once in a while, it doesn't work and something sneaks through in the wrong order and I can't figure out why. calls = zoho.crm.searchRecords("Calls","(Owner:equals:" +

                                  • Automatic needs analysis for the Deals module

                                    Good day, I need to get the following functionality in the Deals module: 1. add a Analysis of Customer Needs (ACN) to each transaction 2. the ACN must have a unique number, preferably automatic 3. the ACN must link to the Deal 4. the ACN is completed

                                  • Odd differential in Accounting and Physical Stock

                                    Hi there, Around six months ago we noticed that there was an error in one of our product's stock values. Despite seemingly having no outwards requests unfufilled for this item (I.E, no stock committed any longer at the moment), Accounting Stock is -1

                                  • 7008 Request rate limit exceeded. Please retry again later.

                                    Hello, I'm encountering an issue with the request limit for my function calls. The function is triggered whenever a new record is created, and in many cases, we create these records in bulk (around 50 at a time). For each record, a workflow is initiated

                                  • Tip #34- How to Configure Proxy Settings for Unattended Access in Zoho Assist- 'Insider Insights'

                                    Hey Zoho Assist Community! For those using Zoho Assist's Unattended Access feature, you may come across a need to configure your device through a proxy server. This setup is particularly useful if your network requires strict proxy configurations for

                                  • Let's Take Custom Slideshow A Step Further!

                                    Zoho Show comes with this useful feature called Custom Slideshow. It is, as implied by the name, a feature for slideshowing. I would argue it is a waste to use the feature just for slideshowing. For a custom slideshow, you define a subset of slides. Of

                                  • Copy Address button customisation

                                    Hi I'm very new to Zoho CRM and need some help regarding Addresses - specifically in relation to the "Copy Address" buttons available within the Contacts and Potentials edit screens.   The majority of my Leads will have both a Mailing Address and a Physical street Address that I need to capture at Lead creation stage.   On conversion of the Lead (to Contact/Account and Potential) I need the following to occur:   In Potentials I need to display ·         Physical Address only   In Accounts I need

                                  • Add Ability to Set Full Name When Inviting Users to Private Client Portals

                                    Hi Zoho Creator Team, We hope you're doing well. We’d like to request a usability improvement for client portal invitations in Zoho Creator. When setting up a client portal with the "Private" Portal Type (where only users invited by the admin can access

                                  • email address issue

                                    Hi! I am start using zoho to start my company's email marketing campaign, but I can not send the email because is showing that Your email address is already configured as a sender address in another account. But I created a new business email address

                                  • Can Zia summarize fields?

                                    A great use case of AI for me would be summarizing company descriptions. We often get long winded descriptions from databases or scraping websites, then reduce them to a couple of sentences stating what a company actually does. Is there any way within

                                  • Difference between the file extensions .zdoc and .zwriterlink

                                    I am using Workdrive TrueSync on my windows pc to open files directly from my windows without having to open them from the workdrive web. But, I found something strange, I also have the zoho writer app installed on my windows and if I create a document

                                  • Deluge should permit a connection to be set with a variable

                                    Hello, Being one who occasionally likes to post code in the forums, I try to make anything that the end user needs to define be present at the very top of the script so that those who want to implement the script won't have to hunt through lines of code,

                                  • Items (products) Export to PDF Feature as a Catalog Generator

                                    Would like to request a product catalog feature where the admin can export "items" along with selected attributes (e.g.: product name, size, price, etc) in a professional template as a PDF document.  Since product pictures and the product attributes are already saved in our system DB, it would be a natural extension to just export it out as a catalog for customers.  I've been duplicating this feature in other apps to make a product catalog.  Having a central repository of "items" makes good sense,

                                  • Allow SO Item table to search other fields in items to make entry easier

                                    We have thousands of items, some of which need to be entered on the fly by desk people. We don't want abstracts like the vendor's part number in our SKU or Item name. It would make order entry much easier if the context search in the items table would

                                  • Zoho Inventory Amazon Integration

                                    The Zoho Developer Account is not valid for Amazon UK and returns this response whilst set up: This Developer Account Number 861444729264 is not valid for the GB marketplace

                                  • Sales by Customer

                                    Hi There, I am looking to generate a report that shows the total value of the sales made to our customers, but does not show each transaction i.e. Customer A = $100,000 Customer B = $50000 and so on This is based on a "Closed Won" in the Deals Module.

                                  • Enhance Bot Functionality for Scheduled Reminders

                                    Dear Zoho Cliq Team, We are writing to request an enhancement to the bot functionality within Zoho Cliq. Currently, bots can be added to channels and send messages, but they lack the ability to schedule reminders. Our team utilizes a deluge code to send

                                  • Zoho Expense - Update Expense Report through web API

                                    Hello, I am currently having issues updating fields in expense reports (not individual expenses) through the API as described in the API documentation. When I make that request using the invokeAPI Deluge function, I receive a response from the API saying

                                  • How to switch templates in Zoho Commerce

                                    I have set up a template in Zoho Commerce and would like to change it. How do I do this?

                                  • How to use filters on all products page? Or even a category page?

                                    Hello, I am trying to create some filters so users can use filters to find products they are looking for. So what i am trying is to create a filter according to price lets say. So if i define it this way i am expecting to see this filter option on category

                                  • How to show product categories on side menu?

                                    Every time I add a category it appears on the main menu. I would like the main menu for things like contact us, blog etc.. and a side menu to the left of the screen for product categories. How do I make them appear in a side menu or even in a category

                                  • How to Add Custom Sections in the Product Page?

                                    Hi Zoho team, I’m currently using the Tranquil theme on Zoho Commerce and I have a question regarding the product page layout. Right now, under each product, I can see expandable sections like Product Details and Specifications. I’d like to add two additional

                                  • Unable to validate DMARC for the email

                                    I have recently started to use the ZOHO CRM tool and I'm currently on free trial period. However, when I tried to test the email, it was landing in SPAM or JUNK folder of the recipient's inbox. I learnt about the DMARC, so i have completed SPF and DKIM

                                  • Migrating Shopify Customers and Tags to Zoho Commerce

                                    I’m exploring options for migrating our existing Shopify customer accounts into the Zoho Commerce member portal. Specifically, I have a few questions: API Availability: Is there a public API or supported endpoint that allows us to import Shopify users

                                  • Multilingual website feature

                                    Would be a great feature to have. I saw that this feature was available for backstage. I think it could be done for zoho sites too.

                                  • Feature Suggestion for Zoho Social: Auto-reply to Comments or Keywords

                                    Hi Zoho team, I'd like to suggest a very specific feature that would be extremely helpful for customer engagement: the ability to automatically send a reply to comments on posts — either all comments or those containing specific keywords. For example,

                                  • Next Page