Manage Browse AI Data in DBArtisan as a JDBC Source

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

Integrate Browse AI Data into DBArtisan Projects

Follow the steps below to register Browse AI 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.

   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.

   

   Below is a typical connection string:

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

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

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