How to Connect Shopify to Bold BI: A Step-by-Step Guide
Shopify is an e-commerce platform that enables businesses to manage their online stores, products, and orders. Bold BI allows you to connect your Shopify store and visualize key business metrics through interactive dashboards.
Prerequisites
Before connecting Shopify to Bold BI, you need to complete the following steps in your Shopify store:
- Create a Developer App – This allows you to generate API credentials required for integration.
- Enable Required API Scopes – Set permissions to define the data Bold BI can access.
- Obtain API Credentials – Retrieve the API Key, API Secret Key, and Admin API Access Token, which are needed to establish the connection.
Once these prerequisites are met, you can proceed with setting up the connection in Bold BI. The following sections provide a step-by-step guide to completing the entire process.
Steps to Create a Developer App in Shopify
Integrating Bold BI with Shopify requires the creation of a developer app within the Shopify platform. This app will allow you to set scope permissions and obtain the necessary API key for connecting Bold BI to your Shopify store. Follow the steps below to create your developer app.
Step 1: Log in to Your Shopify Admin Panel
Begin by logging into your Shopify Admin Panel. You can do this by navigating to your store’s URL, which typically follows the format https://yourstore.myshopify.com/admin
.
Step 2: Navigate to App Settings
Once you are logged in, locate the settings menu. This can be found in the bottom left corner of the Shopify admin dashboard. Click on Settings
to open the settings menu.
Step 3: Access Developer App Section
From there, select Apps and sales channels
to proceed to the app management section. In the Apps and sales channels section, look for the option labeled Develop Apps
. This is usually located in the top right corner of the page. Click on this option to access the developer app management interface.
Step 4: Create a New App
To create a new app, click on the Create an App
button. You will be prompted to enter a name for your app.
It is advisable to choose a descriptive name, such as Bold BI Integration, to easily identify the app later. After entering the name, click on the Create App
button to proceed.
Steps to Set API Scopes in the Shopify Developer App
When integrating Bold BI with your Shopify store, it is essential to configure the appropriate API scopes in your Shopify Developer App. API scopes determine the level of access that Bold BI will have to your store’s data, ensuring that the application can retrieve and manipulate the necessary information effectively.
Step 1: Configure Admin API Scopes
Click on the Configure Admin API Scopes
button. This will allow you to set the permissions that Bold BI will require to function correctly.
Step 2: Select Necessary Permissions
You will see a list of available permissions. Enable the necessary scopes based on the data you wish to access.
Below is a table of common scopes and their descriptions:
Scope | Description |
---|---|
read_customers |
Fetch customer details |
read_orders |
Retrieve order data |
read_products |
Get product inventory |
read_transactions |
Access financial transactions |
Step 3: Save Your Changes
After selecting the necessary scopes, make sure to click the Save
button to apply your changes.
Important Note:
- The scopes you configure are crucial for defining permissions for the Admin API. This API allows applications to access and manipulate a store’s data directly through the Shopify admin interface.
- Ensure that you only enable the scopes that are necessary for your integration to maintain security and data integrity.
By following these steps, you can successfully set the API scopes in your Shopify Developer App, allowing Bold BI to connect and interact with your store’s data as needed.
Steps to Obtain the Shopify API Key & Secret Token
Integrating Bold BI with Shopify requires obtaining the necessary API credentials from your Shopify Developer App. This process involves a few straightforward steps to ensure that you have the API Key, Secret Token, and Admin API access token needed for a successful connection. Below is a detailed guide on how to obtain these credentials.
Step 1: Navigate to the API Credentials Tab
Navigate to the API Credentials
tab. This section contains all the necessary information for API integration.
Step 2: Install the App
In the API Credentials tab, you will see an option to Install App
. Click on this button to generate the required credentials. This step is crucial as it activates the API access for your app.
Step 3: Reveal the Admin API Access Token
After installing the app, you will find the Admin API access token
section. Click on the Reveal token
button to display the token. This token is essential for authenticating your API requests.
Step 4. Copy and Securely Store Your Credentials
Once you have revealed the token, make sure to copy the following information and store it securely:
- Domain Name: This is the URL of your Shopify store.
- API Key: A unique identifier for your app.
- API Secret Key: A secret used to authenticate your app.
- Admin API Access Token: The token that allows your app to access the Shopify Admin API.
Note: It is important to keep these credentials confidential and secure, as they provide access to your Shopify store’s data.
Creating a Shopify Data Source in Bold BI
To create a Shopify data source in Bold BI, follow the detailed steps outlined below. This guide will help you configure the data source effectively.
Step 1: Access the Data Sources Panel
- Click on the
Data Sources
button in the configuration panel to initiate the process of adding a new data connection.
Step 2: Create a New Connection
- Click on
CREATE NEW
to launch a new connection from the connection panel. - From the list of available connections, select the
Shopify
connection.
Step 3: Configure the Shopify Data Source
Once you have selected the Shopify connection, the NEW DATA SOURCE
configuration panel will open. Follow these steps to set up your Shopify data source:
- Enter a Name and Description: Provide a name for the data source. A description is optional but can be helpful for future reference.
- Shop Domain: Input the
Shop Domain
for the connected Shopify account. - Select Resources: Click on the
Resources
dropdown and choose the required endpoint that you wish to connect to.
- Set the Method: In the
Method
combo box, select theGET
method for the REST API. - Choose Data Format: In the
Data Format
combo box, selectJSON
as the data type. - Authentication Type: Choose
Basic HTTP Authentication
in theAuthentication Type
combo box. - API Credentials: Enter a valid
Shopify API Key
andAPI Password
(Admin API access token) to authenticate and access the endpoints.
Step 4: Connect to the Data Source
- Click on
Connect
to establish a connection using the configurations you have set.
Step 5: Choose Schema(s)
After connecting, the Choose Schema(s)
dialog will open. This dialog represents the key fields of the JSON data retrieved from the Shopify REST API request.
- The dialog displays a list of schemas in a tree view along with their corresponding values in a grid for preview.
- Select the required schema(s) from the tree view that you wish to use in the designer and click
Connect
.
Step 6: Design the Data View and Save the Data Source
- Now, the data design view page with the selected table schema will open.
- Drag the table from the tree view in the left pane and drop it onto the Query designer page.
- Finally, click on
Save
to save the data source for future use.
By following these steps, you will successfully create a Shopify data source in Bold BI, allowing you to visualize and analyze your Shopify data effectively.
Conclusion
By following these steps, you can successfully connect Shopify to Bold BI and create real-time analytics dashboards. This helps in tracking customer behavior, product sales, and financial transactions efficiently.