- A. Set up a Shopify connection
- B. Edit Shopify application details
- C. Edit advanced Shopify settings
- D. Test the connection
Start establishing a connection to Shopify in either of the following ways:
- From the Resources menu, select Connections. Then, click + Create connection at the top right.
– or –
- While working in a new or existing integration, you can add an application to a flow simply by clicking Add source or Add destination/lookup.
In the resulting Application list, select Shopify.
The Create connection pane opens with required and advanced settings.
At this point, you’re presented with a series of options for providing Shopify authentication.
Name (required): Provide a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection, and a unique identifier will prove helpful later when selecting among a list of connections that you’ve created.
Application (required, non-editable): A reminder of the app you’re editing.
Authentication type (required): Select Basic (the OAuth 2.0 option is described separately).
Store URL (required): Enter your Shopify subdomain. For example, if https://tchotchkes4ma.myshopify.com is the base URI, then type tchotchkes4ma for this setting.
Version (required): Select the Shopify API version, such as 2020-10.
API key (required): Paste in the API key from your Shopify account.
Password (required): Enter the admin API password (not your Shopify account password). Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s password safe. When editing this form later, you must enter this value again; it is stored only for a saved connection.
The custom app feature in Shopify helps you build an app exclusively for your Shopify store. You can use custom apps to add features to your Shopify admin, access the store's data directly using Shopify's APIs, or extend your online store to other platforms using the storefront API.
Note: Shopify has deprecated private apps in January 2022. You can now create a custom app. For more information, see Shopify Custom Apps.Before you create a custom app for your store, the store owner must enable custom app development in Shopify. To enable the same, see Enable custom app development from the Shopify admin.
Create the app
- Log in as an admin to Shopify. From your Shopify left menu, click Apps.
- Click Develop apps.
- Click Create an app.
- In the modal window, enter the App name and select an App developer. The app developer can be the store owner or any staff or collaborator account with Develop apps permission.
- Click Create app.
Select API scopes
After you create a custom app, you are taken to the Overview page, where you can assign the API scopes. A custom app can have Admin API scopes, Storefront API scopes, or both, depending on the requirements of the app.
- In the Configure Admin API scopes section, select the API scopes that you want to assign to the app. This API scope enables you to connect your store data to your backend services.
- Optional: Set the API version you want to use for webhook subscriptions.
- Optional: Set up Google Cloud Pub/Sub to handle webhook subscriptions for the app. In the Google Cloud Pub/Sub section, copy your Shopify service account address and use it to configure your Google Cloud Pub/Sub account.
- Optional: Set up Amazon EventBridge to handle webhook subscriptions for the app. In the Amazon EventBridge section, click Create source.
- In the Configure Storefront API scopes section, select the API scopes that you want to assign to the app. This API scope enables you to develop unique shopping experiences.
Caution:The Storefront API is an unauthenticated public API, which means that all data you expose to the app could be seen by any visitors to your store. You should use the Storefront API only if you are comfortable with this risk, and you should give permissions for only the types of data that the private app needs.
- Click Save.
Note: Before you install the app, you must select at least one scope.
Install the app and get the API access tokens
After you've set API scopes for your app, you can install the app. You'll get your API access tokens after you install. Depending on what API scopes you assigned to the app, you'll get an Admin API access token, a Storefront API access token, or both.
- Click Install app.
- In the modal window, click Install.
- Get the access token:
- If you have selected Admin API scopes for the app, then go to the Admin Credentials section and click Reveal token once.
Caution:You can see the Admin API access token on this page only one time because the token provides API access to sensitive store data. After revealing the access token, write down or record the token somewhere secure so that you can refer to it again. Treat the token like a password. Share the access token only with developers that you trust.
- If you selected Storefront API scopes for the app, then you can go to the Storefront API access token section and copy your token. Unlike the Admin API access token, the Storefront API access token is always available on this page.
After revealing the full access token once, this page displays only the last 4 digits of the access token for reference.
Before continuing, you have the opportunity to provide additional configuration information, if needed, for the Shopify connection.
Once you have configured the Shopify connection, you have a few options for continuing:
- Save – click this button to test the connection, commit the new connection so that it will be available to all integrations for your account
- Save & close – click to test and save the connection and exit the Create connection pane
- Cancel – click to exit without saving any new changes
- Test connection – click this button to verify that your new connection is free of errors
When you test or save the connection, it is verified before continuing.
The new connection is now successfully added to your account. It will be applied to the current source or destination app, if you created it within a flow. Otherwise, you may proceed to register the connection with an integration.