Connect to Browse AI Data in Aqua Data Studio

The CData JDBC Driver for Browse AI integrates Browse AI data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Browse AI data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Browse AI data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Browse AI.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

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

     BrowseAI API Profile Settings

     BrowseAI is a web scraping and automation platform that allows you to train robots to extract and monitor data from websites. Authentication is performed using an API key that is sent as a Bearer token in the Authorization header.

     The BrowseAI API key has the format {userId}:{apiKey}, where both parts are UUIDs separated by a colon. This full string is provided as a single value in the BrowseAI dashboard.

     To obtain your API key:

     1. Log in to your BrowseAI account at https://app.browse.ai
     2. Navigate to Settings in the dashboard
     3. Locate the API section
     4. Copy the full API key string displayed (format: userId:apiKey)

     After obtaining your API key, set the following connection properties:

     • AuthScheme: Set this to APIKey.

     Set the following in the ProfileSettings connection property:

     • APIKey: Set this to your BrowseAI API key (format: userId:apiKey).

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Browse AI 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 typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\BrowseAI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_user_id:your_api_key';

   

Query Browse AI Data

You can now query the tables exposed.