The Java SDK for Zoho CRM allows developers to easily create Java applications that can be integrated with Zoho CRM. This SDK serves as a wrapper for the REST APIs, making it easier to access and utilize the services of Zoho CRM. Authentication to access the CRM APIs is done through OAuth2.0, and the authentication process is streamlined through the use of the Java SDK. The grant and access/refresh tokens are generated and managed within the SDK code, eliminating the need for manual handling during data synchronization between Zoho CRM and the client application.
This repository includes the JAVA SDK for API v7 of Zoho CRM. Check Versions for more details on the versions of SDK released for this API version.
Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED
All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
- Added new page_token param in GetAttachmentsParam class.
- DealContactRolesOperations class method name chnaged(deleteContactRoleRealation to deleteContactRoleRelation).
- Added category, sort_by, sort_order, and filters param in GetEmailTemplatesParam class.
- Added new fields (referenceValue, dealCategory, and showValue) in fields PickListValue class.
- Added new filters param in GetInventoryTemplatesParam class.
- Modules displayField field datatype changed(String to Object).
- Added new status param in GetModulesParam class.
- Added new paramInstance param in ModulesOperations class getModules method.
- Added new type param in SearchRecordsParam class.
- Added new cvid param in RecordCountParam class.
- Added new page_token, page, and per_page param in GetRecordLockingInformationsParam class.
- Added new color_code param in CreateTagsParam class.
- Added new ids param in GetTerritoriesParam class.
- Added new page and per_page param in GetChildTerritoryParam class.
- Added new filters, page, and per_page param in GetAssociatedUsersCountParam class.
- Added new paramInstance param in UserGroupsOperations class getAssociatedUsersCount method.
- Deprecated and removed API methods:
- UsersTerritories
- validateBeforeTransferForAllTerritories
- validateBeforeTransfer
- delinkAndTransferFromAllTerritories
- delinkAndTransferFromSpecificTerritory
- UsersTerritories
- Support for the following new APIs
- AuditLogExport
- Cadences
- DealContactRoles
- InventoryConvert
- InventoryMassConvert
- Layouts
- Modules
- Record
- RecordLockingConfiguration
- RecycleBin
- usergroups
- UsersTerritories
- ZiaEnrichment
-
- Email Related Records Email class threadId field datatype changed(Long to String).
-
- Supported delete field in PickListValue in Fields API.
-
- RemoveTagsFromMultipleRecordsParam class IDS param datatype changed(Long to String).
-
- Handled Error Structure in MassDeleteTags API.
-
-
JAVA SDK upgraded to support v7 APIs.
-
JAVA SDK improved to support the following new APIs
-
For older versions, please refer.
You can include the SDK to your project using:
- Maven
- Gradle
- Download SDK jar
For including the latest version using Maven, include the following in your pom.xml file, which will get created once your Java project is created using Maven.
```xml
<repositories>
<repository>
<id>zohocrm-java-sdk-7-0</id>
<url>https://maven.zohodl.com</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>com.zoho.crm</groupId>
<artifactId>zohocrm-java-sdk-7-0</artifactId>
<version>5.0.0</version>
</dependency>
</dependencies>
```
NOTE
- The access and refresh tokens are environment-specific and domain-specific. When you handle various environments and domains such as Production, Sandbox, or Developer and IN, CN, US, EU, JP, or AU, respectively, you must use the access token and refresh token generated only in those respective environments and domains. The SDK throws an error, otherwise. For example, if you generate the tokens for your Sandbox environment in the CN domain, you must use only those tokens for that domain and environment. You cannot use the tokens generated for a different environment or a domain.
- For Deal Contact Roles API and Records API, you will need to provide the ZohoCRM.settings.fields.ALL scope along with the ZohoCRM.modules.ALL scope while generating the OAuthtoken. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error.
- For Related Records API, the scopes required for generating OAuthtoken are ZohoCRM.modules.ALL, ZohoCRM.settings.fields.ALL and ZohoCRM.settings.related_lists.ALL. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error.
- For Mass Convert API, you will need to provide the ZohoCRM.settings.fields.ALL scope along with the ZohoCRM.mass_convert.leads.CREATE and ZohoCRM.mass_convert.leads.READ scope while generating the OAuthtoken. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error.
For more details, kindly refer here.