How to connect to ConstantContact Data with Squirrel SQL client



Connect to ConstantContact data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for ConstantContact enables you to execute queries to ConstantContact data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for ConstantContact data and execute queries.

Add the JDBC Driver for ConstantContact

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for ConstantContact.
  4. In the Example URL box, enter jdbc:api:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.api.APIDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData ConstantContact Source.
    • Driver: Select the CData JDBC Driver for ConstantContact.
    • URL: Enter jdbc:api:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    Start by setting the Profile connection property to the location of the ConstantContact Profile on disk (e.g. C:\profiles\ConstantContact.apip). Next, set the ProfileSettings connection property to the connection string for Profile (see below).

    ConstantContact API Profile Settings

    ConstantContact uses OAuth-based authentication.

    First, you will need to register an OAuth application with ConstantContact. You can do so from the ConstantContact API Guide (https://v3.developer.constantcontact.com/api_guide/index.html), under "MyApplications" > "New Application". Your Oauth application will be assigned a client id (API Key) and you can generate a client secret (Secret).

    After setting the following connection properties, you are ready to connect:

    • AuthScheme: Set this to OAuth.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
    • OAuthClientId: Set this to the client_id that is specified in you app settings.
    • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
    • CallbackURL: Set this to the Redirect URI you specified in your app settings.

    Below is a typical connection string:

    jdbc:api:Profile=C:\profiles\ConstantContact.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query ConstantContact Data

After the metadata has loaded, a new tab for the ConstantContact data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT Id, EmailAddress FROM Contacts WHERE CompanyName = 'Acme, Inc.'

Ready to get started?

Connect to live data from ConstantContact with the API Driver

Connect to ConstantContact