Manage PhantomBuster Data in DBArtisan as a JDBC Source

The CData JDBC Driver for PhantomBuster seamlessly integrates PhantomBuster data into database management tools like DBArtisan by enabling you to access PhantomBuster data as a database. This article shows how to create a JDBC source for PhantomBuster in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate PhantomBuster Data into DBArtisan Projects

Follow the steps below to register PhantomBuster data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   

   Below is a typical connection string:

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

6. Finish the wizard to connect to PhantomBuster data. PhantomBuster entities are displayed in the Datasource Explorer.

You can now work with PhantomBuster data as you work with any other database. See the driver help documentation for more information on the queries supported by the PhantomBuster API.