Prerequisites - Shopify  

Before creating and using a Connector, please review the following requirements and prerequisites.

• Shopify Partner Account Setup
• Specialized Licensing
• Technical Assumptions

Note: The Shopify Connector supports two authentication types:

• OAuth 2.0 Code Flow Grant Type
• Access Token

Shopify Partner Account Setup

To use Shopify Connector with OAuth 2.0 Flow Grant Type authentication (vault entry), you must have a Shopify Partner account to access ClientId (API key), Client Secret(API secret) and Redirect URL, along with a Shopify account to obtain the Shop URL.

How to obtain ClientId (API key) and Client Secret(API secret):

ClientId: The API key for the app, as defined in the Partner Dashboard.

Client Secret: The API secret key for the app, as defined in the Partner Dashboard.

1. Create a Shopify Partner account. You can sign up for a free Shopify Partner account by registering here.
2. Generate the API credentials from the Partner Dashboard. You can create a public application from your Partner Dashboard.
   1. Log in to Partner Dashboard
   2. Click on App -> Create App
   3. Provide an app name, URL, and Redirection URLs
   4. Click on Create App

   

   You will be redirected to the app's overview page, where you can view the API key and API secret that you will need for authentication

Redirect URL

The URL to which a user is redirected after authorizing the client. The complete URL specified here must be added to your app as a whitelisted redirection URL, as defined in the Partner Dashboard.

Redirection URLs you provided in the previous step when you create a public application from your Partner Dashboard

Shop URL: https://{shop}.myshopify.com where {shop} is the name of the user’s shop. 

Example: https://cleoApp.myshopify.com

To obtain the Shop URL, you must create an account on https://www.shopify.com/

To create a Shopify Connector with an Access Token authentication (vault entry), you must have:

• Shopify account to obtain the Shop URL
• Shopify access token

To retrieve an access token for a given custom application, take these steps:

1. From your Shopify admin, click Settings > Apps and sales channels.
2. Click Develop apps.
3. Click the name of the app that you want the credentials for.
4. Click API credentials.

For more information, refer to the Shopify help center article on Custom Apps.

Protected customer data

Shopify is introducing updated requirements for apps that use customer data. As of version 2022-10 of the Admin API, published, public apps must meet the protected customer data requirements.

To request access:

1. From the Partner Dashboard, go to Apps, and then select your app.
2. In the sidebar, click App setup.
3. Find Protected customer data access and click Request access.
4. Select Protected customer data, provide your reasons for using it, and click Save.
5. If your app needs access to protected customer fields, then select the relevant fields, provide your reasons for using them, and click Save.
6. Complete your Data protection details, making sure that your app meets the protected customer data requirements.
7. Click Submit for review.

If your app is for testing or installed only on a development store, you can access customer data in development after Step 5. You don't need to submit for review.

For more information on Shopify-protected customer data please visit: https://shopify.dev/docs/apps/store/data-protection/protected-customer-data

Specialized Licensing Required

The Application Connector requires a specialized server license. See your Customer Account Manager. 

Technical Assumption

Effective use of the Connector assumes the following:

• You are familiar with the development and organization of your external application account.
• You know the particulars of your data and the external processes to manage it.
• You have understanding of how to create and share resources, and publish (deploy) integration projects in CIC Studio.