Ready to get started?

Learn more about the CData FireDAC Components for Zendesk or download a free trial:

Download Now

Build a Simple VCL Application for Zendesk Data

How to build a simple VCL Application to view Zendesk data in RAD Studio using the CData FireDAC Components for Zendesk.

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData FireDAC Components for Zendesk, you gain access to live Zendesk data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve and update Zendesk data. This article will walk through connecting to Zendesk and creating a simple VCL application with the Form Designer.

Creating a VCL Application for Zendesk Data

The following instructions show how to use the Form Designer to create a simple VCL Forms application that shows the basic FireDAC objects needed to connect to Zendesk from any application.

The following example populates a TDBGrid control.

  1. Create a new VCL Forms Application.
  2. Drop a TFDPhysZendeskDriverLink and TFDConnection object onto the form.
  3. Double-click the TFDConnection object. The FireDAC Connection Editor is displayed. Select "CData.Zendesk" in the DriverId menu and configure the 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.

  4. Drop a TFDQuery object onto the form and set the properties below:

    • Connection - Set this property to the TFDConnection object, if this object is not already specified.
    • SQL - Click the button in the SQL property and enter a query.
    • Active - Set this property to true.
  5. Drop a TDataSource object onto the form and set the following property:

    • DataSet - In the menu for this property, select the name of the TFDQuery object.
  6. Drop a TDBGrid control onto the form and set the following property:

    • DataSource - Select the name of the TDataSource.
  7. Drop a TFDGUIxWaitCursor onto the form. This is required to avoid a run-time error.

You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.