Connect to Zendesk Data in Aqua Data Studio

The CData JDBC Driver for Zendesk integrates Zendesk data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Zendesk data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Zendesk data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Zendesk.
   • Driver Location: Click the Browse button and select the cdata.jdbc.zendesk.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.zendesk.ZendeskDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:zendesk: and is followed by a semicolon-separated list of connection properties.

     Connecting to Zendesk

     To connect, set the URL and provide authentication. The URL is your Zendesk Support URL: https://{subdomain}.zendesk.com.

     Authenticating to Zendesk

     You can authenticate using the Basic or OAuth methods.

     Using Basic Authentication

     To use Basic authentication, specify your email address and password or your email address and an API token. Set User to your email address and follow the steps below to provide the Password or ApiToken.

     • Enable password access in the Zendesk Support admin interface at Admin > Channels > API.
     • Manage API tokens in the Zendesk Support Admin interface at Admin > Channels > API. More than one token can be active at the same time. Deleting a token deactivates it permanently.

     Using OAuth Authentication

     See the Getting Started guide in the CData driver 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 Zendesk JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.zendesk.jar

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

     A typical JDBC URL is below:
     jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;InitiateOAuth=GETANDREFRESH

Query Zendesk Data

You can now query the tables exposed.