Kaizen #15 - Java SDK for Self Client
Hello everyone!
Welcome to yet another post in the Kaizen series.
This week, we are going to discuss the Java SDK for a self client .
What is a Software Development Kit (SDK)?
A software development kit contains all the tools (compiler, debugger, code samples, and so on) that are needed to create applications in one package. SDKs are language-specific and thus used to build client applications in a specific programming language.
Java Software Development Kit
Java SDK allows you to create a client Java applications that can be integrated with Zoho CRM effortlessly. It serves as a wrapper for the REST APIs , thus making it easier to use the services of Zoho CRM.
Here is a sample of how SDK acts as a middleware between Zoho CRM and Client Java Application.
What can you do with the Java Software Development Kit?
- You can use Java SDK to exchange data between Zoho CRM and the client Java application.
- The authentication process becomes hassle-free with Java SDK. Since it is handled in the SDK code by default, you need not worry about generating the grant token, access/refresh tokens every time you sync data between Zoho CRM and your self client.
Environment Setup
Java SDK requires Java version 7 or above to be set up in your development environment.
Including the Java SDK in your project
You can include the Java SDK in your project using:
a. Maven distribution
b. Gradle
c. Downloadable JARs
a. Maven distribution - It is a build automation tool used primarily for Java projects. Include the following code to your pom.XML file.
<repositories> <repository> <id>java-sdk</id> <url> https://maven.zohodl.com </url> </repository> </repositories> <dependencies> <dependency> <groupId>com.zoho.crm</groupId> <artifactId>java-sdk</artifactId> <version>2.0.2</version> </dependency> </dependencies> |
b. Gradle - It is also a build tool, similar to Maven. The major difference is that, instead of XML files, Gradle uses Groovy (a domain-specific programming language) to declare the Java project configuration. You need to add the following code to your build.gradle file.
repositories{ maven { url " https://maven.zohodl.com " } } dependencies{ implementation 'com.zoho.crm:java-sdk:2.0.2' } |
c. Downloadable JARs (by Zoho) - Java Archive is a platform-independent file format that aggregates many files into one. The JAR file consists of the SDK. You have to download individual dependency JARs and add them to your reference libraries in your Java application: Download JAR (SDK)
Click here to download the dependency JARs.
The list of dependency JARs are:
- hamcrest-all-1.3 : Hamcrest consists of a single jar file that contains base classes and a library of useful matcher implementations.
- httpclient-4.4.1 : The Apache HttpClient library allows you to handle HTTP requests.
- httpcore-4.4.4 : HttpCore is a set of low-level HTTP transport components that you can use to build custom client and server-side HTTP services.
- httpmime-4.5.3 : The Apache HttpMime library consists of MIME code entities.
- json-20170516 : The files in this package implement JSON encoders/decoders in Java. It also includes the capability to convert between JSON and XML, HTTP headers, Cookies, and CDL.
- servlet-api-2.5 : Servlet API consists of classes to support HTTP servlet.
- commons-logging-1.1.3 : The commons-logging JAR provides an API for logging in server-based applications that you can use around a variety of different logging implementations.
- mysql-connector-java-5.1.44-bin.jar : You need to include this JAR if you are using a MySQL database. MySQL Connector JAR provides connectivity for java client applications with MySQL Connector (a driver that implements the Java Database Connectivity (JDBC) API)
How to start using the Java SDK?
In this section, we will discuss how to start using the Java SDK for your application (authenticated via self-client) which uses Zoho CRM.
- Prerequisite: Register your application
- Knowlege Base: Adding persistence classes
- Initialization
1. Prerequisite: Register your application
All the Zoho CRM APIs are authenticated by the OAuth2.0 standards . It is mandatory to authenticate the self client with Zoho.
Step 1: Goto https://api-console.zoho.com
Step 2: Click ADD CLIENT
Step 3: Choose Self Client and click CREATE NOW
Step 4: Choose the Client Type as Self Client , and click CREATE .
Step 5: Once you successfully register your self-client, you will receive a Client ID and Client Secret .
2. Knowledge Base: Adding persistence classes
This section consists of two parts:
a. Initializing your client application
b. Adding persistence classes
a. Initializing your client application
To authenticate the client application, you need to add the following key-value configuration pairs to the initialization code of your java client.
Key Description
Key | Description |
client_id, client_secret, and redirect_uri mandatory | You can get these values after registering your client. |
currentUserEmail mandatory | The Email ID of the current user. |
persistence_handler_class mandatory | The implementation of ZohoOAuthPersistenceInterface |
logFilePath optional | The absolute/relative file path of the file that stores the logs. |
domainSuffix optional | The domain from which the API calls are made. It can be .com (for US), .eu (for Europe), .cn (for China). If you specify this value, you need not specify apiBaseUrl and iamURL. |
accessType optional | The type of environment from which the API calls are made. Possible values are "Production", "Development", or "Sandbox" |
access_type optional | Must be set as as "offline". Online OAuth client is not supported by the Java SDK as of now |
apiBaseUrl optional | The URL that is used to make API calls. You need not specify this value if you give domainSuffix. The possible values are: https://www.zohoapis.com (default) |
iamURL optional | The accounts URL. You need not specify this value if you specify domainSuffix. The possible values are: |
mysql_password and mysql_username mandatory when you use MySQL persistence | The MySQL username and password, respectively. |
Key Value Configuration
HashMap <String, String> zcrmConfigurations = new HashMap <String, String >(); zcrmConfigurations.put("minLogLevel", "ALL"); zcrmConfigurations.put("currentUserEmail","{user_email_id}"); zcrmConfigurations.put("client_id","1000. xxxxxxxxx"); zcrmConfigurations.put("client_secret","xxxxxxxxxxxx"); zcrmConfigurations.put("redirect_uri",""); zcrmConfigurations.put("persistence_handler_class","com.zoho.oauth.clientapp.ZohoOAuthDBPersistence ");//for database. "com.zoho.oauth.clientapp.ZohoOAuthFilePersistence" for file, user can implement his own persistence and provide the path here zcrmConfigurations.put("oauth_tokens_file_path","/path/to/oauthtokens.properties");//optional path can be absolute(Ex:/User/Document/testapplication/src/oauthtokens.properties) or relative (Ex: /testapplication/src/oauthtokens.properties) zcrmConfigurations.put("domainSuffix","com");//optional. Default is com. "cn", "eu", and "in" supported zcrmConfigurations.put("accessType","Production");//Production->www(default), Development->developer, Sandbox->sandbox(optional) zcrmConfigurations.put("access_type","offline");//optional zcrmConfigurations.put("apiBaseUrl"," https://www.zohoapis.com ");//optional zcrmConfigurations.put("iamURL"," https://accounts.zoho.com ");//optional zcrmConfigurations.put("logFilePath","/path/to/file.log");//path can be absolute(Ex:/User/Document/testapplication/src/file.log) or relative (Ex: /testapplication/src/file.log) zcrmConfigurations.put("mysql_password","pass@123");//optional zcrmConfigurations.put("mysql_username",username");//optional ZCRMRestClient.initialize(zcrmConfigurations);//for initializing |
2. Adding persistence class
Your application should retain tokens (grant, access, and refresh tokens) to automate the process of data-sync between your java application and Zoho CRM.
You can persist tokens in your application by using any one of the below mentioned persistence methods:
a. By using an implementation of the inbuilt ZohoPersistenceHandler interface .
- ZohoOAuthFilePersistence (To store tokens in a File )
- ZohoOAuthDBPersistence (To store tokens in a Database )
b. By using your own implementation
Let us now look into each of the above mentioned methods.
a. By using an implementation of the inbuilt ZohoPersistenceHandler interface
Our Java SDK provides two default implementations of the ZohoPersistenceHandler interface within the client library. They are:
i. ZohoOAuthFilePersistence
ii. ZohoOAuthDBPersistence
i. ZohoOAuthFilePersistence - This type of persistence uses a file to read and write OAuth tokens. The file persists the token of a single user. So, it is best used for the 'self-client' type of authentication since it involves only one user.
Values to be given in configuration map
persistence_handler_class =com.zoho.oauth.clientapp.ZohoOAuthFilePersistence
oauth_tokens_file_path =absolute or relative path of the "oauthtokens.properties" file in the workspace.
ii. ZohoOAuthDBPersistence - This type of persistence uses MySQL persistence. You can use this type of persistence if you have more than one user using the application.
Some of the prerequisites for using this type of persistence are:
- MySQL should be running in the same machine serving at the default port 3306.
- The database name should be "zohooauth".
There must be a table "oauthtokens" with the columns "useridentifier" (varchar(255)), "accesstoken" (varchar(255)), "refreshtoken" (varchar(255)) and "expirytime" (bigint).
Values to be given in configuration map
persistence_handler_class =com.zoho.oauth.clientapp.ZohoOAuthDBPersistence
mysql_username =root
mysql_password ={your MySQL password}
b. By using your own implementation
You can also use your own implementation. The ZohoPersistenceHandler interface must have the following methods:
- getOAuthTokens() — invoked to fetch the saved tokens. This method should return ZohoOAuthTokens object for the library to process it.
- saveOAuthData(ZohoOAuthTokens tokens) — invoked to store the tokens.
- deleteOAuthTokens() — invoked to delete the tokens.
C. Initialization
Intializing your application involves the following steps:
Step 1: Generating the grant token
Step 2: Generating the access and refresh tokens using the grant token
Step 3: Generating the access token using the refresh token
Step 1: Generating the Grant Token
(i). Go to https://api-console.zoho.com/
(ii). Choose Self-Client
(iii). Enter the comma separated ZohoCRM scopes along with aaaserver.profile.READ . Choose the time duration (the grant token will be valid only till the time chosen here) and enter the description . Now, click GENERATE.
(iii). Copy the grant token displayed
Step 2: Generating the Access and Refresh Tokens
After obtaining the grant token, put the following code snippet in a java file and execute it from your main class to get access and refresh tokens.
ZCRMRestClient.initialize(configurations_map); ZohoOAuthClient cli = ZohoOAuthClient.getInstance(); String grantToken = “paste_the_self_authorized_grant_token_here”; ZohoOAuthTokens tokens = cli.generateAccessToken(grantToken); String accessToken = tokens.getAccessToken(); String refreshToken = tokens.getRefreshToken(); System.out.println("access token = " + accessToken + " & refresh token = " + refreshToken); |
2a. On using ZohoOAuthFilePersistence method
The access and refresh tokens are generated and stored in the oauth_tokens.properties file .
2b. On using ZohoOAuthDBPersistence method
The access and refresh tokens are generated and stored in " oauthtokens " table of your MySQL
Step 3: Generating the Access token from Refresh token
Use the below code snippet to generate the access token from the refresh token.
ZohoOAuthClient client = ZohoOAuthClient.getInstance(); client.generateAccessTokenFromRefreshToken(refreshToken, userMailId); |
Sample SDK Code
When you build your application using the Java SDK, the code template will be similar to:
Refer to the attachment to get the code. For more sample codes, refer to our SDK guide .
The isTokenGenerated Method:
This method checks if the access token has already been generated or not. It returns a boolean value:
true - The access token has already been generated.
false - The access token has not been generated previously, thus, it shifts the control to the code snippet that leads to access token generation.
See you next week with another post.
Cheers!
Previous 'Kaizen' - Notification API
Next 'Kaizen' - Python SDK
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Sneha Sridharan
Umashankar
Praveen Sankar
Sticky Posts
Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
There was an error while connecting to GSTN
I am trying to file GSTR1. Everything flows smoothly until I reach the final step of filing the return. After I enter the PAN and OTP for filing it raises the error "There was an error while connecting to GSTN"Zoho Books Extension: What Happens If Custom Fields Already Exist?
When developing Zoho Books extensions, what happens if the target Zoho Books organization already has a custom field with the same API name as one defined in the extension? I’m asking because we originally created an on-Books version of this functionality,Internal Server Error (500) When Attempting to View Banking Transactions
I am experiencing an Internal Server Error (500) when attempting to view transactions across all of my banking accounts. Despite multiple attempts to resolve this, I have received little more than runaround from support, and the issue remains unresolved.How do I add a blank line to the Organisation Address Format?
I'd like to have my VAT number, for example, shown prominently by having a clear gap between it and the address block above, but any blank lines in the address format get ignored in PDF outputs.Automatic Invoice Number generation for createRecord
Hello, while testing some custom Buttons in my Zoho Books application, I noticed that I get an error that previously did not occur. After some further digging I found that the automatic transaction numbering of invoices no longer work in my organization.Adding number of days to an estimate.
I need both QTY of item and "number of days hire" in my estimates at the line item level. Any clues as to how this is done would be greatly appreciated. It needs to calculate. Thanks JBooks Api: listing expenses created after certain dates
Is there any parameter I can add to the List Expenses endpoint that will let me look up expenses by when they were created?Why can't we change the Account type from an Expense to an Asset?
Like the question. Why in QuickBooks for example if I mistakenly created an account as an expenses and I already captured information in those accounts, I can just change the account type from expense to assetIs it possible to do validation for the Actions added to Reports?
We have an all-around On Validate function that checks all the possibilities before the Created/Edited form submissions. We want to have a button in the report view, so we can change records without entering. We are able to add this button, and it does[Free Webinar] Environments in Zoho Creator - Creator Tech Connect
Hello Everyone, We’re delighted to kick off the 2026 edition of the Zoho Creator Tech Connect Series and are excited to continue this learning journey with you. The Creator Tech Connect series is a free monthly webinar featuring deep-dive technical sessionsZoho Voice API SMS
I made a post request in Zapier to try to send an SMS. Authentication appears to be configured correctly. I followed the documentation and I'm getting a 400 Error "Internal Server Error". Not helpful at all. Anyways, I could not find any information onHow do I change (error) display messages
Hi! I would like to edit display messages like "invalid entries" and "enter a value for Nome" and so on into Italian language messages. How can I do that? Already tried on Validate on form submit. Where I am failing? Thanks in advance.Record Overseas Transactions Along with CC charges
Hi All, We receive payments via stripe in multiple currencies and stripe takes around 2.5% fees. The amount is settled in INR into our local bank. What should be the currency of the income account used for Stripe payments? Here is a sample flow that weEasier onboarding for new users with stage descriptions
Greetings, I hope all of you are doing well. We're happy to announce a recent enhancement we've made to Bigin. You can now add descriptions to the stages in your pipeline. Previously, when creating a pipeline, you could only add stages. With this update,Pieds de page personnalisé - Document Zoho Writer
Bonjour à tous, Je rencontre un souci avec l’ajout d’un pied de page personnalisé dans un document Zoho Writer. Je souhaite insérer les informations de mon entreprise (notamment un logo + adresse) dans le pied de page. Le problème, c’est que lorsque j’ajouteCredit card transactions are backwards after importing statements
I am new to Zoho Books so I'm importing my firm's bank and credit card statements in. My credit card statements have a single column with negative numbers so that is the option I chose. But when I went to categorize the credit card transactions, I canPermissions on Views
Having the option of any agent creating custom views is firing back and got a situation where there are a hundred different views across the team and tickets are not being dealt in the most efficient of ways. Tickets seems to be missed by some agents,Function #8: Add additional charges to invoices
Here goes one of the highly sought-after custom functions in Zoho Books. If you find yourself needing to apply additional charges to customers on their invoices (say credit card surcharges, or fuel charges applicable to customers from a certain region,VIsual maindmaps in Zoho notebook Ai
Can I create and export VIsual maindmaps in Zoho notebook Ai1stDibs Integration to Zoho Inventory
Hello is it possible to integrate my Zoho inventory and 1stDibs?Community Question: Renewal vs Invoicing
This is a question for the community. Does anyone else consider there to be a difference between a subscription renewal event and sending out a recurring invoice for a subscription? For example, let's say customer XYZ purchases a 1-year subscription tocloud console support for music websites
Hi Friends, I am not from a very technical background.. So need support from the Zoho family. I want to build a e-commerce website which is in Musical Niche. It will help people learn music & play instruments of all types. There are a few players in the market like Chordify , Guitaa, Guitar Dashboard, ChordU & few others. But I all these websites allow only a few instruments to play. So I want to build a better website than the one I mentioned. So wnated to know what UI & AI should I use so thatScheduled Reports - Do not send empty report
Hello, We are intensively using reports in the CRM, especially for sales managers. When data is empty, they still receive an email. Can you add an option to avoid sending the report when data is empty?Is Zoho One Desktop more secure than Zoho One Web SaaS?
Is Zoho One Desktop more secure than using Zoho One in browser? Inherently, it seems desktop would be unless you don't do things like share your pw or leave pc on. I am concerned about data being on the cloud or someone else's server and database.Reminder Settings - Time Tracker
On the time tracker in Reminder Settings I created a reminder according to the Zoho manual. But a manager asked me to change the message that goes in the email. Is it possible to change the message? I didn't find that in the Zoho manual. Another question: I configured to receive the reminder everyone who logged in less than 40 hours. Does Zoho consider less than 40 hours of the current week or the whole month? Another situation, I put it so that I and another specific user would receive the notification,Create Item group from a composite Item
I have applied my mind for hours but cannot figure this out. Can you have a composite item in an item group?. E.g. We bundle different color and size SKU's together as composite items. Also Using composite items as Bill of Materials. We want to createMain difference of Zoho Recruit Corporte version and Staffing HR vesion
Hi Zoho, I need help to fully understand what is the main key point differences of Recruit Corporate version versus the Staffing HR version? We are currently using Corporate HR version and we are looking on having an insightful automated reporting, doesOut of Stock items showing in Commerce
I have over 6000 items and most are not in stock, but all items are showing up in Commerce whether they are inventory or not. What option or feature can you use to hide items in Commerce at zero or negative quantities? I currently am using Commerce forIs it possible to transfer data from one related list to another within the same module ?
In the Leads module, there is an existing default Product related list that already contains data. Recently, I added a custom multi-lookup field, which created a new related list in the same Leads module. Now, I need to move the existing data from theHow to implement new online payment gateway?
Hello, Can you tell me how to proceed to implement my local payment gateway? DIBS has an open avaiable API that should be easy to implement into ZOHO BOOKS. http://tech.dibspayment.com/dibs_payment_windowFormula working in MS Excel , is not working in Zoho Sheets, Filter fuction which is working in MS sheets per the attached workbook / Daily update.
Filter function , which is working in MS Excel is not working in Zoho sheets. Please help on function of filter of particular class sheets and extract students name who has more than 3.5 hours of study hours on particular day depending on date in D7 cell.New in Smart Prompt: Record Assistant for contextual assistance, and support for new AI models
Smart Prompt helps teams stay informed and move faster by providing relevant suggestions where work happens in CRM. With this update, Smart Prompt becomes more adaptable to your organization’s AI preferences. You can now choose which Large Language ModelImproved Integration Failure Information (And Notification Options)
Hi, When an attachment service for example fails, you just get "Field x - Error", I can check the field it is failing on and find nothing wrong, same file size, type, dimensions, etc. so more information as to the actual issue would be helpful. And anChange User Role in a Form
Hi, When in a form, it would be good (And consistent) to be able to change the user role/permission like you can with Shared Reports, All Entries or the actual User itself, rather than having to delete the users permission and then add it back again withReassign Partially Saved Entries
Hi, I would like to be able to go to Partially Saved Entries and like the option to delete them I would like the option to multi-select and be able to reassign them to another user to complete (Such as when a user has left the company). Thanks DanIncrease the "Maximum Saved Entries per User" Options Limit
Hi, You can create lots of saved entries, yet the Limit when you apply one is 25, we may often expect 32 to be in draft, and therefore want to enforce that, can we increase the limit of this field from 25 to 100 (As you can just turn it off and have moreProduct Updates in Zoho Workplace applications | December 2025
Hello Workplace Community, Let’s take a look at the new features and enhancements that went live across all Workplace applications this December. Zoho Mail Block emails without notifying the sender Block emails without sending a rejection notificationZoho CRM for Gmail Extension Not Working in Brave Browser?
Is anyone able to get the Zoho CRM Chrome Extension working in the Brave browser? They're both built on the Chromium platform and every other Chrome Extension works with the exception of Zoho CRM for Gmail so any ideas here?Set Frozen Cells in the Report Settings
Hi, It would be nice to be able to set the frozen cells in the report Settings, and have an option if this is fixed or can be changed after loading (On the next load it still goes back to the Settings). Thanks DanMicrosoft Teams now available as an online meeting provider
Hello everyone, We're pleased to announce that Zoho CRM now supports Microsoft Teams as an online meeting provider—alongside the other providers already available. Admins can enable Microsoft Teams directly from the Preferences tab under the MeetingsNext Page