JDBC Driver for Freshdesk

Build 24.0.9060

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 Freshdesk 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.freshdesk.FreshDeskDriver
  • Provide the JDBC URL. For example:
    jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;
    
    or
    
    jdbc:cdata:freshdesk:Domain=MyDomain;APIKey=myAPIKey;

    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:freshdesk:" or "jdbc:cdata:freshdesk:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Freshdesk

Freshdesk makes use of basic authentication. To connect to data, set the following connection properties:

  • Domain: Set this to the domain associated with your Freshdesk account. For example, in your URL, https://{domainValue}.freshdesk.com, thus the connection string should be:

    Domain=domainValue

  • APIKey: Set this to the API key associated with your Freshdesk account. To retrieve your API key, log in to your support Portal. Click the profile picture in the upper-right corner and select the profile settings page. The API key is available below the change password section to the right.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060