Manage Webflow Data in DBArtisan as a JDBC Source

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

Integrate Webflow Data into DBArtisan Projects

Follow the steps below to register Webflow 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. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in 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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

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

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