JDBC Driver for Zendesk

Build 22.0.8462

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Zendesk consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.zendesk.ZendeskDriver
  • Provide the JDBC URL. For example:
    jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
    
    or
    
    jdbc:cdata:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:zendesk:" or "jdbc:cdata:zendesk:" and can include any of the connection properties in name-value pairs separated with semicolons.

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

Zendesk uses Basic authentication or the OAuth 2 authentication standard.

To authenticate to Zendesk, you can use either Basic authentication or the OAuth standard. Use Basic to connect to your own data. Use OAuth to allow other users to connect to their data.

Basic

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.
  1. Enable password access in the Zendesk Support admin interface at Admin > Channels > API. Set AuthScheme to Basic while using APIToken Authentication.
  2. 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.

OAuth

OAuth requires the authenticating user to interact with Zendesk using the browser. Set AuthScheme to OAuth while using OAuth Authentication. See Using OAuth Authentication for an authentication guide.

NOTE: By using UseIncrementalAPI property we can get the archived data for TicketMetrics table.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462