Learn more
 

Ready to get started?

Connect to live data from Zenefits with the API Driver

Connect to Zenefits

In this article

Related articles

Rapidly Develop Zenefits-Driven Apps with Active Query Builder


Leverage the Active Query Builder SQL interface builder and the ease of .NET data access to create data-driven WinForms and ASP.NET apps.

Write standard .NET to expose Zenefits data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for Zenefits enables standards-based access to Zenefits. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to Zenefits as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Use SQL to Interact with Zenefits

Follow the steps below to create a WinForms visual query builder.

  1. Open Active Query Builder for .NET WinForms.
  2. In the new Windows Forms project go to the "File" menu and click "Connect..."
  3. Under Database Connections, click "Add..."
  4. Set your desired Connection Name (e.g. CData Zenefits), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown.
  5. Click "OK" to save the new connection.
  6. Back in the Database Connection wizard, select the newly created connection and click "OK."
  7. Click "File" > "New Query" to create a QueryBuilder

You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.