Learn more
 

Ready to get started?

Connect to live data from Zenefits with the API Driver

Connect to Zenefits

In this article

Related articles

Connect to Zenefits Data in JRuby


Create a simple JRuby app with access to live Zenefits data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Zenefits makes it easy to integrate connectivity to live Zenefits data in JRuby. This article shows how to create a simple JRuby app that connects to Zenefits data, executes a query, and displays the results.

Configure a JDBC Connection to Zenefits Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Zenefits\lib).

JRuby natively supports JDBC, so you can easily connect to Zenefits and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

Start by setting the Profile connection property to the location of the Zenefits Profile on disk (e.g. C:\profiles\Zenefits.apip). Next, set the ProfileSettings connection property to the connection string for Zenefits (see below).

Zenefits API Profile Settings

In order to authenticate to Zenefits, you'll need to provide your API Key. To create an API Key, from your account head over to Company Overview > Custom Integrations, then besides Rest API Access select Add Token. Set the API Key in the ProfileSettings property to connect.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

Below is a typical JDBC connection string for Zenefits:

jdbc:api:Profile=C:\profiles\Zenefits.apip;ProfileSettings='APIKey=my_api_token';

Create a JRuby App with Connectivity to Zenefits Data

Create a new Ruby file (for example: APISelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Zenefits 2018/lib/cdata.jdbc.api.jar' url = "jdbc:api:Profile=C:\profiles\Zenefits.apip;ProfileSettings='APIKey=my_api_token';" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Title FROM People") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Zenefits data with JRuby. To do so, simply run your file from the command line:

jruby -S APISelect.rb

Writing SQL-92 queries to Zenefits allows you to quickly and easily incorporate Zenefits data into your own JRuby applications. Download a free trial today!