Learn more
 

Ready to get started?

Download a free trial of the Zoho Books Driver to get started:

 Download Now

Learn more:

Zoho Books Icon Zoho Books JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Zoho Books.

In this article

Related articles

Create a Data Access Object for Zoho Books Data using JDBI


A brief overview of creating a SQL Object API for Zoho Books data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Zoho Books integrates connectivity to live Zoho Books data in Java applications. By pairing these technologies, you gain simple, programmatic access to Zoho Books data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Zoho Books data.

Create a DAO for the Zoho Books INVOICES Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyINVOICESDAO { //request specific data from Zoho Books (String type is used for simplicity) @SqlQuery("SELECT InvoiceNumber FROM INVOICES WHERE CustomerName = :customerName") String findInvoiceNumberByCustomerName(@Bind("customerName") String customerName); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Zoho Books

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Zoho Books.

Zoho Books uses the OAuth authentication standard. To authenticate using OAuth, create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the OAuth section of the Getting Started guide in the Help documentation for an authentication guide.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Zoho Books JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.zohobooks.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Zoho Books will typically look like the following:

jdbc:zohobooks:OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;CallbackURL=https://localhost:33333;OrganizationId=MyOrganizationId;InitiateOAuth=GETANDREFRESH

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:zohobooks:OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;CallbackURL=https://localhost:33333;OrganizationId=MyOrganizationId;InitiateOAuth=GETANDREFRESH"); MyINVOICESDAO dao = dbi.open(MyINVOICESDAO.class); //do stuff with the DAO dao.close();

Read Zoho Books Data

With the connection open to Zoho Books, simply call the previously defined method to retrieve data from the INVOICES entity in Zoho Books.

//disply the result of our 'find' method String invoiceNumber = dao.findInvoiceNumberByCustomerName("NewTech Industries"); System.out.println(invoiceNumber);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Zoho Books by integrating with the CData JDBC Driver for Zoho Books. Download a free trial and work with live Zoho Books data in custom Java applications today.