Create a Data Access Object for PhantomBuster Data using 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 PhantomBuster integrates connectivity to live PhantomBuster data in Java applications. By pairing these technologies, you gain simple, programmatic access to PhantomBuster data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read PhantomBuster data.

Create a DAO for the PhantomBuster Agents 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 MyAgentsDAO {
  //request specific data from PhantomBuster (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Agents WHERE  = :")
  String findBy(@Bind("") String );

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to PhantomBuster

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

Using API Key Authentication

To use the Phantombuster API, you need to obtain an API key from your Phantombuster account settings. Navigate to phantombuster.com, click your profile icon, select Settings, and copy the API key from the API section.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Phantombuster API key from the account settings page.

Multi-Organization Accounts

If your API key is associated with multiple organizations, you can target a specific organization by setting the OrganizationId connection property to the desired organization identifier. When set, it is sent as the X-Phantombuster-Org request header.

Example connection string:

Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the PhantomBuster 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 PhantomBuster will typically look like the following:

jdbc:api:Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"

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\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"");
MyAgentsDAO dao = dbi.open(MyAgentsDAO.class);

//do stuff with the DAO

dao.close();

Read PhantomBuster Data

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

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

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