Rapidly Develop PhantomBuster-Driven Apps with Active Query Builder

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Leverage the Active Query Builder SQL interface and .NET data access to create data-driven WinForms and ASP.NET apps backed by PhantomBuster.

Write standard .NET to expose PhantomBuster data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for PhantomBuster enables standards-based access to PhantomBuster. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to PhantomBuster as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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"

Use SQL to Interact with PhantomBuster

Follow the steps below to create a WinForms visual query builder.

  1. Open Active Query Builder for .NET WinForms.
  2. In the new Windows Forms project go to the "File" menu and click "Connect..."
  3. Under Database Connections, click "Add..."
  4. Set your desired Connection Name (e.g. CData PhantomBuster), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown.
  5. Click "OK" to save the new connection.
  6. Back in the Database Connection wizard, select the newly created connection and click "OK."
  7. Click "File" > "New Query" to create a QueryBuilder

You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.

Ready to get started?

Connect to live data from PhantomBuster with the API Driver

Connect to PhantomBuster