Learn more
 

Ready to get started?

Connect to live data from Unbounce with the API Driver

Connect to Unbounce

In this article

Related articles

Create a Data Access Object for Unbounce Data using JDBI


A brief overview of creating a SQL Object API for Unbounce data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Unbounce integrates connectivity to live Unbounce data in Java applications. By pairing these technologies, you gain simple, programmatic access to Unbounce data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Unbounce data.

Create a DAO for the Unbounce Tags Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyTagsDAO { //request specific data from Unbounce (String type is used for simplicity) @SqlQuery("SELECT Name FROM Tags WHERE State = :state") String findNameByState(@Bind("state") String state); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Unbounce

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Unbounce.

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

Unbounce API Profile Settings

Unbounce uses OAuth to authenticate to your data.

In order to authenticate to Unbounce, you will first need to register an OAuth application. To do so, go to https://developer.unbounce.com/getting_started/ and complete the Register OAuth Application form.

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 your app settings.
  • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Unbounce JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Unbounce will typically look like the following:

jdbc:api:Profile=C:\profiles\Unbounce.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Unbounce.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH"); MyTagsDAO dao = dbi.open(MyTagsDAO.class); //do stuff with the DAO dao.close();

Read Unbounce Data

With the connection open to Unbounce, simply call the previously defined method to retrieve data from the Tags entity in Unbounce.

//disply the result of our 'find' method String name = dao.findNameByState("active"); System.out.println(name);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Unbounce by integrating with the CData JDBC Driver for Unbounce. Download a free trial and work with live Unbounce data in custom Java applications today.