Establishing a Connection

The objects available within our connector are accessible from the "cdata.shopify" module. To use the module's objects directly:

Import the module as follows:
```
import cdata.shopify as mod
```

To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:

mod.connect("InitiateOAuth=GETANDREFRESH;ShopUrl=https://yourshopname.myshopify.com;OAuthClientId=myoauthclientid;OAuthClientSecret=myoauthclientsecret;")

Connecting to Shopify

This section describes how to connect to Shopify from the web, a desktop application, or a headless application.

Connecting via Access Token

Connecting via an access token takes two steps:

Use the Shopify admin page to create the access token
Use your access token to authenticate

Create the Access Token

Follow the steps below to register an application and obtain the access token:

Log in to your Shopify from the admin page and navigate to Apps > Apps and sales channels.
Click Develop apps and select Create an app.
In the Overview tab, click Configure Admin API scopes and select the access permissions for your store that you want to grant to your application. The permissions required by our provider to use all the tables and views are:
- read_assigned_fulfillment_orders, write_assigned_fulfillment_orders
- read_content, write_content
- read_customers, write_customers
- read_draft_orders, write_draft_orders
- read_fulfillments, write_fulfillments
- read_gift_cards, write_gift_cards
- read_inventory, write_inventory
- read_marketing_events, write_marketing_events
- read_orders, write_orders
- read_price_rules, write_price_rules
- read_product_listings, write_product_listings
- read_products, write_products
- read_reports, write_reports
- read_script_tags, write_script_tags
- read_shopify_payments_payouts
- read_themes, write_themes
- read_markets
- read_shopify_payments_accounts
- read_publications
- unauthenticated_read_content (Storefront API)
Click Save.
Select API Credentials.
Under "Access tokens" click Install app. This creates your access token.
Copy your access token under Admin API Access token. NOTE: The token can be revealed and copied only once.

Authenticate via Access Token

To authenticate using an access token, specify the following:

AuthScheme: Set to AccessToken.
AccessToken: Set to the access token value you copied from the custom app.

Connecting via OAuth

Shopify supports OAuth authentication. In all cases, AuthScheme must be set to OAuth, and you must create a custom OAuth application. See Creating a Custom OAuth Application for for more information.

Desktop Applications

Follow the steps below to authenticate with the credentials for a custom OAuth application.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId: Set this to the client Id assigned when you registered your application.
OAuthClientSecret: Set this to the client secret assigned when you registered your application.
CallbackURL: Set this to the redirect URI defined when you registered your application.

When you connect, the connector opens Shopify's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from Shopify and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation. These values persist across connections.

The connector refreshes the access token automatically when it expires.

Web Applications

When connecting via a Web application, you need to register a custom OAuth application with Shopify. You can then use the connector to get and manage the OAuth token values. See Creating a Custom OAuth Application for more information.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: Set this to the client Id in your application settings.
OAuthClientSecret: Set this to the client secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Redirect URI you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic Refresh of the OAuth Access Token

To have the connector automatically refresh the OAuth access token, set the following on the first data connection.

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the client Id in your application settings.
OAuthClientSecret: Set this to the client secret in your application settings.
OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
OAuthSettingsLocation: Set this to the location where you want the connector to save the OAuth values, which persist across connections.

On subsequent data connections, set the following:

InitiateOAuth
OAuthSettingsLocation

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

Choose one of two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
Then configure the connector to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow these steps:

First, set the following properties:
- InitiateOAuth: Set to OFF.
- OAuthClientId: Set to the client Id assigned when you registered your application.
- OAuthClientSecret: Set to the client secret assigned when you registered your application.
Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
- Log in and grant permissions to the connector. You are then redirected to the redirect URI. There is a parameter called code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: Set this to REFRESH.
OAuthVerifier: Set this to the noted verifier code (the value of the code parameter in the redirect URI).
OAuthClientId: Set this to the client Id in your custom OAuth application settings.
OAuthClientSecret: Set this to the client secret in the custom OAuth application settings.
OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the client Id assigned when you registered your application.
OAuthClientSecret: Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is "OAuthSettings.txt".

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the client Id assigned when you registered your application.
OAuthClientSecret: Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

CData Python Connector for Shopify