Connect to Webflow Data in NetBeans

The CData JDBC Driver for Webflow integrates connectivity to live Webflow data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Webflow data in NetBeans. You will create a connection and load Webflow data in the Table Editor.

Create a JDBC Data Source for Webflow in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

• Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.api.jar file. The driver JAR is located in the lib subfolder of the installation directory.
• Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.api.APIDriver from the menu.
• Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

1. In the Service window, right-click the Database node and click New Connection.

2. In the New Connection Wizard, enter the following connection properties:

   • Driver Name: In the menu, select the CData JDBC Driver for Webflow.
   • User Name: Enter the username. This can also be defined in the JDBC URL.
   • Password: Enter the password. This can also be defined in the JDBC URL.

   • JDBC URL: Specify the JDBC URL.

     Authentication

     Webflow uses OAuth 2.0 authentication to ensure secure access to sites, CMS collections, e-commerce data, and other resources. This authentication method allows you to securely connect to your Webflow workspace and manage resources with proper authorization.

     OAuth 2.0 Setup and Configuration

     Step 1: Create a Webflow OAuth Application

     To set up OAuth authentication:

     1. Visit the Webflow Developer Portal
     2. Navigate to "Apps & Integrations" in your Webflow account
     3. Click "Register an App" to create a new OAuth application
     4. Configure the application name, description, and redirect URI (CallbackURL)
     5. Copy the Client ID and Client Secret for use in your connection

     Required Connection Properties

     • AuthScheme: Set this to OAuth (required)
     • OAuthClientId: Client ID from your Webflow OAuth application (required)
     • OAuthClientSecret: Client secret from your Webflow OAuth application (required)
     • CallbackURL: Redirect URI specified in your OAuth application (required)
     • InitiateOAuth: Set to GETANDREFRESH for automatic token management (recommended)

     Required OAuth Scopes

     The Webflow API Profile requires the following OAuth scopes:

     • sites:read - Read access to site information and configuration
     • pages:read - Read access to site pages
     • cms:read - Read access to CMS collections and items
     • forms:read - Read access to forms and form submissions
     • assets:read - Read access to media assets and folders
     • ecommerce:read - Read access to products, orders, and inventory
     • authorized_user:read - Read access to the authorized user

     Built-in Connection String Designer

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

     jdbc:api:Profile=C:\profiles\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Query Webflow Data

To connect to Webflow data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data..