VOOZH about

URL: https://www.cdata.com/kb/tech/bigcommerce-cloud-metabase.rst

⇱ How to integrate Metabase with BigCommerce Data


How to integrate Metabase with BigCommerce Data

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to live BigCommerce data and create an interactive dashboard in Metabase from BigCommerce data.

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live BigCommerce data. This article describes how to connect to BigCommerce and build a simple visualization using BigCommerce data.

CData Connect provides a pure cloud-to-cloud interface for BigCommerce, allowing you to easily integrate with live BigCommerce data in Metabase β€” without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to BigCommerce, leveraging server-side processing to quickly return BigCommerce data.

Configure BigCommerce Connectivity for Metabase

Connectivity to BigCommerce from Metabase is made possible through CData Connect AI. To work with BigCommerce data from Metabase, we start by creating and configuring a BigCommerce connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "BigCommerce" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to BigCommerce.

    BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

    Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

    1. Log in to your BigCommerce account.
    2. From the Home Page, select Advanced Settings > API Accounts.
    3. Click Create API Account.
    4. A text box named API Path will appear on your screen.
    5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
    6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
    7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.
    πŸ‘ Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add BigCommerce Connection page and update the User-based permissions. πŸ‘ Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. πŸ‘ Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to BigCommerce data from Metabase.

Connect to CData Connect AI from Metabase

After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.

  1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab πŸ‘ Adding a new database connection to Metabase.
  2. Configure the connection to Connect AI and click "Save"
    • Database type: Select "SQL Server"
    • Name: Name the connection (e.g. "BigCommerce (Connect AI)")
    • Host: tds.cdata.com
    • Port: 14333
    • Database name: The name of the connection you just created (e.g. BigCommerce1)
    • Username: A Connect AI username (e.g. [email protected])
    • Password: The PAT previously created
    • Click to Use a secure connection (SSL)
    πŸ‘ Configuring the connection to Connect AI.

Execute BigCommerce Data with Metabase

Once you configure the connection to Connect AI, you can query BigCommerce and build visualizations.

  1. Use the "Write SQL" tool to retrieve the BigCommerce data πŸ‘ Click the 'Write SQL' button.
  2. Write a SQL query based on the BigCommerce connection in CData Connect AI, e.g.

    SELECT FirstName, LastName FROM Customers WHERE FirstName = 'Bob'
    πŸ‘ Collected data (Salesforce is shown).
  3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization πŸ‘ Collected data (Salesforce is shown).

More Information & Free Trial

At this point, you have built a simple visualization from BigCommerce data in Metabase. You can continue to work with live BigCommerce data in Metabase just like you would any SQL Server database. For more information on creating a live connection to BigCommerce (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live BigCommerce data in Metabase today.