Skip to main content

Zoho CRM API

Eric Elfline
  • Updated

This will require Data Admin privileges to setup and Builder for implementation.

iDashboards is able to connect to a Zoho CRM API by using a Premium Data Connector (CDATA JDBC driver). A JDBC driver is a software component enabling a Java application to interact with a database. To connect with individual databases, JDBC (Java Database Connectivity API) requires specific drivers for each database. The JDBC driver gives out the connection to the database and implements the protocol for transferring the query and result between the client and the database. iDashboards implements native protocols and does not require additional software installed on the driver host. In other words, iDashboards provides driver connectivity with the JDBC Data Source via the specified driver. This document explains a step-by-step procedure to create the Data Source with a Premium Data Connector.

CDATA for Zoho – Creating Your Zoho App – Building the Connection String – Data Connection

CDATA for Zoho

CData JDBC Driver for Zoho CRM is where we get the documentation on making this connection, however, the Premium Data Connections are not straight forward process which is why we make articles like this to help you make the connections more easily. This one requires a few steps, with a few different links to get very specific pieces of information to make this connection within iDashboards. The Zoho API is part of the Premium Data Connectors if you do not have these please contact your Client Success Manager. 

Building the Connection String – Data Connection

Creating Your Zoho App

  •  Login to the Zoho Developer Console
  • Click Add Client ID  and fill out the following:
    • Client Name
    • Domain
    • Redirect/Callback URL
  • Click Create and you will be shown your Client ID and Client Secret
    • Copy the Client ID and Client Secret to notepad and click Close
  • You should be taken back to the Developer Console
  • If for some reason you need see the Client ID and Secret or update the information you previously filled in like the Callback URL you can click the ellipsis (...) and Edit

Data Connection

Building the Connection String

  1. Open the Zoho driver (cdata.jdbc.zohocrm.jar) to update the connection properties found in the following location: C:\Program Files\iDashboards_SRV\ivizgroup\drivers
    • If you are unable to open by double clicking it can be accomplished via command line:
      • cd C:\Program Files\iDashboardsSRV\ivizgroup\drivers
      • Then type the command: java  -jar cdata.jdbc.zohocrm.jarzoho_connection_properties.PNG
  2. Fill in the following:
    • Callback URL
    • Client ID
    • Client Secret
    • Set Initiate OAuth to GETANDREFRESH
  3. Stop the iDashboards service (iDashboardsSRV)
  4. In the Connection Properties click Test Connection 
    • You should see a browser pop up with a CDATA page stating that the connection is successful, it also generated some files you need that should be located in the following location:
    • C:\Users\<YourUserName>\AppData\Roaming\CData\ZohoCRM Data Provider
  5. In the connection string properties set Initiate OAuth to REFRESH and start the iDashboards service. 
  6. Finally we're going complete the connection string
  7. Copy the connection string you built in the driver and past it notepad
  8. At the end of the connection string you need to add the path to the OAuthSettings.txt you created. 
    • jdbc:zohocrm:Initiate OAuth=REFRESH;OAuth Client Id=<YourClientID>;OAuth Client Secret<YourClientSecret>;OAuth Settings Location=C:\Users<YourUserName>\AppData\ Roaming\CData\ZohoCRM Data Provider\OAuthSettings.txt

CDATA for Zoho – Creating Your Zoho App

Data Connection

Follow the steps below to set up a data source in iDashboards Admin or Data Hub.

  1. Select Data Sources

  2. Click New

  3. Set the Data Source Type to Generic JDBC

  4. In the Create a Data Source window fill in the highlighted fields:mceclip0.png

    • Database URL*: copy the connection string you created

    • JDBC Driver Class: cdata.jdbc.zohocrm.ZohoCRMDriver

  5. Click Save, your connection has been created.

For More Information:

Disclaimer: iDashboards Technical Support Engineers are not proficient in the Management and Integration of every API that exists as new APIs are being created everyday with each company that wants to provide seamless integration with other software. However, we do our best to help you make these connections because we want to assist you in your success. If you do not see an article for a connection you would like to make please contact iDashboards Support and know that it will take a bit of time to figure out what is necessary for this integration.

If the above is unable to resolve the issue, then please contact iDashboards Support for further assistance.

Creating Your Zoho App – Building the Connection String – Data Connection

Related articles

Comments

0 comments

Please sign in to leave a comment.