Configuring Authentication

To access Shopify data stores, you must authenticate the connection using the OAuth 2.0 protocol. You can do this by providing a valid access token, or by providing your Shopify application information so that the connector initiates an OAuth 2.0 authentication flow to retrieve and use the corresponding access token.

Using an Access Token

If you already have a valid access token, you can authenticate your connection by providing the token in the connection URL.

To authenticate using an access token:

  • Connect to the server using a connection URL written in the following format:

    • jdbc:shopify://localhost;Host=[Endpoint];Auth_Type=OAuth 2.0;Auth_AccessToken=[YourAccessToken];

    The variables are defined as follows:

  • [Endpoint] is the endpoint of the Shopify server that you are connecting to.
  • [YourAccessToken] is your access token for authenticating to Shopify.

For example:

jdbc:shopify://localhost;Host=simbastore.myshopify.com;Auth_Type=OAuth 2.0;Auth_AccessToken=kP9PcyQ7prK2LwUMZMpFQ4R+5VE;

Using Shopify Application Information

You can configure the connector to retrieve and use an access token based on your Shopify application information. To do this, in the connection URL, provide the API key and credential set associated with your Shopify application.

To authenticate using your Shopify application information:

  • Connect to the server using a connection URL written in the following format:

    • jdbc:shopify://localhost;Host=[Endpoint];Auth_Type=OAuth 2.0;Auth_BaseRedirectUri=[RedirectURL];Auth_Client_ID=[YourAPIKey];Auth_Client_Secret=[YourCredentialSet];Auth_Scope=[Scope];

    The variables are defined as follows:

  • [Endpoint] is the endpoint of the Shopify server that you are connecting to.
  • [RedirectURL] is the redirect URL associated with your Shopify application.
  • [YourAPIKey] is the the API key associated with your Shopify application, which is used as the OAuth 2.0 client ID.
  • [YourCredentialSet] is the credential set associated with your Shopify application, which is used as the OAuth 2.0 client secret.
  • [Scope] is a comma-separated list of the OAuth scopes for the access token. For a list of the supported scopes, see "API Access Scopes" in the Shopify documentation: https://help.shopify.com/en/api/getting-started/authentication/oauth/scopes.

For example:

jdbc:shopify://localhost;Host=simbastore.myshopify.com;Auth_Type=OAuth 2.0;Auth_BaseRedirectUri=redirect.shopify.com;Auth_Client_ID=f145kn9Pcyq9pr4lvumdapfl4rive;Auth_Client_Secret=5kn9Pcyq9pr4lvu123pfl4r57;Auth_Scope=write_content,read_content;

The connector uses these settings to go through an OAuth 2.0 authentication flow and authenticate your connection to Shopify.

Related topics