Shopify Query Authentication Guide

Shopify Query Authentication Guide


Overview

This is a step-by-step guide to acquiring credentials and authorising the Shopify Query connector for use in Matillion ETL.

Important Information

  • The Shopify Query connector uses an API token for third-party authentication.
  • Please ensure an active MyShopify shop is already available from which to source data.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Acquiring Third-Party Credentials

  1. Navigate to the Shopify website. Click Log in on the right of the header menu. Log in to the Shopify website

    Log in to the Shopify website

  2. The browser will then redirect to a sequence of login screens beginning with the Store address. Enter the Shopify store address URL to be associated with the app. Then, click Next and enter valid credentials on the subsequent screens to continue.

    Please Note

    This shop address URL used to login here will also be required in Authorising for use in Matillion ETL.

    Provide Store address

    Provide Store address

  3. Once logged in, click Apps on the sidebar on the left of the screen.

  4. Then, in the Apps window, click Create a new private app on the top right above the Private Apps list.

    App dashboard

    App dashboard

  5. On the Create private app window, provide details for the following fields:

    • Private app name – provide a name for the app
    • Emergency developer email – provide an email address for developer communication for the app

  6. Then, scroll down to the Admin API section and click Review disable Admin API Permissions to reveal all API permissions. Ensure all permissions are listed as Read access by clicking the dropdown menu to the right of each permission.

    Create private app

    Create private app

  7. Now, scroll down even further to the Storefront API section. Tick the checkbox next to Allow this app to access your storefront data using the Storefront API, then click Save.

    Please Note

    Ticking this checkbox will also reveal STOREFRONT APP PERMISSIONS sub-section. The options therein, while not mandatory, allow for further customisation of Storefront API permission levels.

    Storefront API permissions

    Storefront API permissions

  8. A pop-up window will then appear to ensure the Shopify API Terms are understood, before creating the app. Click I understand, create the app to confirm.

    Confirm understanding of the Shopify API Terms

    Confirm understanding of the Shopify API Terms

  9. The browser will then return to the app window, now with a block at the top of the window stating, "Private app created successfully". Next, in the Admin API section, copy the codes in the newly created API key and Password fields as they will be required in Authorising for Use in Matillion ETL.

    Please Note

    When copying the codes, some browsers may add a space to the end of the code. Watch out for this as it will cause the credentials to fail.

    Save app details

    Save app details


Authorising for Use in Matillion ETL

  1. If a Shopify Query connector is not already on the job canvas, search "Shopify" using the Components search field, or find the Shopify Query connector under OrchestrationLoad/UnloadInternet.

    Please Note

    An Orchestration Job must be open on the job canvas within Matillion ETL to ensure the Shopify Query connector is searchable within the Components panel.

  2. Then, click and drag the Shopify Query connector onto the job canvas.

    Search for Open Exchange Rates Query connector

    Search for Shopify Query connector

  3. Click the connector icon on the job canvas to open the Properties panel at the bottom of the screen.

  4. Then, click ... next to the Shop URL input.

    Configure App Id in Properties

    Configure App ID in Properties

  5. Then, in the Shop URL pop-up window, paste the Shop URL (used to log into the Shopify website) into the field provided and click OK.

    Paste App Id

    Paste App Id

  6. Next, click ... next to the App Id input. Then, in the App Id pop-up window, paste the API key (copied from the Shopify website earlier) into the field provided and click OK.

    Paste App Id

    Paste App Id

  7. Finally, click ... next to Password input. Then, in the Password pop-up window, paste the Password (copied earlier from the Shopify website) into the Store in component field and click OK.

    Paste Password

    Paste Password

  8. If the App Id is entered correctly, the connector should be authenticated and the status of the input will be displayed as OK.

    Connector successfully authenticated

    Connector successfully authenticated