Manage Zendesk Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Zendesk seamlessly integrates Zendesk data into database management tools like DBArtisan by enabling you to access Zendesk data as a database. This article shows how to create a JDBC source for Zendesk in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Zendesk Data into DBArtisan Projects

Follow the steps below to register Zendesk data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:zendesk:URL=https://subdomain.zendesk.com;[email protected];Password=test123;InitiateOAuth=GETANDREFRESH;

6. Finish the wizard to connect to Zendesk data. Zendesk entities are displayed in the Datasource Explorer.

You can now work with Zendesk data as you work with any other database. See the driver help documentation for more information on the queries supported by the Zendesk API.