This blog will walk you through the process of obtaining all the information required to set up a Shopify DSN.
After installing the Shopify ODBC driver, you will need Host, Client ID, Client Secret and Scope information to get you connected.
You can find this information by logging into your Shopify account where you are able to create “Stores”. Please note that this is not the actual store page.
For example, we have a partner account and are able to log in using the following link:
https://app.shopify.com/services/partners
To obtain the Host name:
- After logging in, Click the “Stores” in the navigation bar and select the Store of choice.
For our example we will be using a store called “DML Test”
- The hostname is found underneath the name of the store. In our case, the hostname is dmltest-2.myshopify.com (outlined in orange)
Based on the screenshot for the DML test, there are 2 applications installed for this store: “Test App” and “DMLTesting” as highlighted in green.
In our example we are going to use “DML Test” app and showcase how to obtain the Client ID and Client Secret.
Obtaining client id and client secret:
- Select the App of choice from the list of applications under the Store of choice. Note that you can also navigate to this view by selecting “Apps” in the navigation bar and selecting the app of choice from the list of available apps.
After selecting the App of choice, click the “App setup”
- First we need to check a few things before obtaining the Client ID and Client Secret
Under the “URL’s” Please note that the App URL should contain the store name which you are interested in connecting to.
You must include at least one redirect URL before making your app public. Merchants are redirected to these whitelisted URLs after the app is installed.
Specify the Whitelisted redirection URL to: http://localhost:6367/
- The Client ID and Client Secret can be found at the bottom of the page
API Key is added as client ID and API Secret Key is added as Client Secret into the ODBC administrator.
Provide scope:
The following documentation addresses scopes https://help.shopify.com/en/api/getting-started/authentication/oauth/scopes
Note that the use of scope gives access permission to the application.
In our example we will use the following scope
read_content,write_content,read_themes,write_themes,read_products,write_products,read_customers,write_customers,read_orders,write_orders,read_script_tags,write_script_tags,read_fulfillments,write_fulfillments,read_shipping,write_shipping,read_analytics,read_all_orders,write_users,read_users
- Now start up ODBC Administrator and add Host, Client ID, Client Secret and Scope into the DSN to authenticate and connect using the ODBC driver.
In our example we are going to set up a System DSN
Start ODBC Administrator, click the System DSN tab, select “Simba Shopify” and click “Configure”
- Add the proper content into the Simba Shopify ODBC Driver DSN Setup and click “Get Access Token”
- A browser will open up and if you get an error such as the following
New Scope:
read_content,write_content,read_themes,write_themes,read_products,write_products,read_customers,write_customers,read_orders,write_orders,read_script_tags,write_script_tags,read_fulfillments,write_fulfillments,read_shipping,write_shipping,read_analytics
- Simply remove the scopes from your list and try again.
After you use the correct scope and click “Get Access Token” from the Simba Shopify ODBC Driver DSN Setup, a browser may pop up asking you to either install or update the unlisted app.
- Simply click either “Install unlisted app” or “Update unlisted app”
Now go back to the Simba Shopify ODBC Driver DSN Setup. There will be an error “Host Unreachable”. This is due to the timing out which occurred as you have accepted installing or updating unlisted app.
Simply Click OK and click “Get Access Token” one more time
- After clicking the “Get Access Token” again a browser will display
- This is normal as the redirect URL was set to localhost:6367. In the ODBC Administrator you will now see that the “Access Token” has been added.
- Simply click “Test” at the bottom of the Simba Shopify ODBC Driver DSN Setup and you should now have a successful connection.
Your DSN is now set and you can use it in various ODBC applications to connect to Shopify.