Java SDK - Overview

Java SDK offers a way to create client java applications that can be integrated with Zoho CRM. This SDK makes the access and use of necessary CRM APIs with ease. In other words, it serves as a wrapper for the REST APIs, making it easier to use the services of Zoho CRM.

A point to note would be that the developer of the client application should create programming code elements along with configuration-related properties files, interface implementations, instances or objects. Authentication to access Zoho CRM APIs is through OAuth authentication mechanism. Invariably, HTTP requests and responses are taken care by SDK.

A sample of how an SDK acts a middleware or interface between Zoho CRM and a client java application.

Java SDK allows you to:

1. Exchange data between Zoho CRM and the client application where the CRM entities are modelled as classes.
   
2. CRM API equivalents are declared and defined as simple member methods in your java application.
   
3. Push data into Zoho CRM, by accessing appropriate APIs of the CRM Service.
   

Note

For the sake of better explanation, we have used Eclipse to describe how to get started on using the SDK.

Environmental Setup

Java SDK requires Java (version 7 and above) to be setup in your development environment.

Including the SDK in your project

Java SDK is available through Maven distribution. You can include the SDK to your project using:

• Maven
  
• Gradle
  
• Downloadable JARs (by Zoho)
  

Maven Distribution

Maven is a build automation tool used primarily for Java projects. Maven addresses two aspects of building software: first, it describes how software is built, and second, it describes its dependencies.

If you are using Maven to build your project, we already have the dependencies set up.

You just need to include the following in your pom.xml file, which will get created once your Java project is created using Maven.

1. <repositories>
   
2.       <repository>
   
3.             <url>https://maven.zohodl.com</url>
   
4.       </repository>
   
5. </repositories>
   
6. 
   
7. <dependencies>
   
8.       <dependency>
   
9.             <groupId>com.zoho.crm</groupId>
   
10.             <artifactId>java-sdk</artifactId>
    
11.             <version>1.0.6</version>
    
12.       </dependency>
    
13. </dependencies>
    

Gradle

1. repositories {
   
2.             maven { url "https://maven.zohodl.com" }
   
3. }
   
4. 
   
5. dependencies {
   
6.             implementation 'com.zoho.crm:java-sdk:1.0.6'
   
7. }
   

Downloadable JAR file

Download SDK

This version downloads simply the SDK without dependent jars. In this case, the following jars are to be made available by adding them in the referenced libraries of your java application. The jars can be downloaded from here.

The list of dependency JARs that you need are:

• hamcrest-all-1.3
  
• httpclient-4.4.1
  
• httpcore-4.4.4
  
• httpmime-4.5.3
  
• json-20170516
  
• servlet-api-2.5
  
• commons-logging-1.1.3
  
• mysql-connector-java-5.1.44-bin.ja
  

SEE ALSO

Register your application

File Structure Hierarchy

Configuration

Persistence

Initialization

Class Hierarchy

Responses & Exceptions

Create your first Java App

Sample Codes

Errors & Solutions

Release Notes

• Related Articles

• Release Notes - Java SDK

  ZCRMSDK -VERSION 1.0.6  Downloadable JAR file  You can download the jar file for the version1.0.6 of Java SDKs at the end of this page.  Install command - Maven:(in pom.xml)  <repositories>        <repository>              ...

• Responses & Exceptions - Java SDK

  APIResponse, BulkAPIResponse and FileAPIResponse are the wrapper objects for Zoho CRM APIs’ responses. All API calling methods would return one of these three objects. A method-seeking entity would return APIResponse object, whereas a method-seeking ...

• Persistence - Java SDK

  Persistent classes in an application implement the entities of the business problem. In Java SDK, two default persistence classes with their implementations are provided. On the other hand, if a developer wants his specific implementation, he can ...

• Configuration - Java SDK

  Setting up the configuration is a system engineering process, for establishing and maintaining the consistency of the application's performance, functional and physical attributes with its requirements, design and operational information throughout ...

• Initialization - Java SDK

  Now the app is ready to be initialized after defining OAuth configuration file and OAuth persistence handler class for your app. Generating grant tokens For a Single User The developer console has an option to generate grant token for a user ...