B4X Requires Chilkat v10.1.2+

Shopify OAuth2 Authentication

See more OAuth2 Examples

This example shows how to obtain an initial access token for a Shopify application using OAuth2 authentication specifically for non-web applications. This process requires displaying a browser window to secure user authorization. In contrast, web-based applications use a different method to obtain an OAuth2 token, as they redirect back to the application via a URL. Note: Once you have the access token, all subsequent Chilkat examples that rely on an already-obtained token are applicable to both web and non-web applications. B4X

Dim success As Boolean = False

'  To further clarify, see OAuth 2.0 Authorization Flow

Dim oauth2 As ChilkatOAuth2
oauth2.Initialize("oauth2")

'  This should be the port in the localhost callback URL for your app.  
'  The callback URL would look like "http://localhost:3017/" if the port number is 3017.
'  Make sure that "http://localhost:3017/" is listed in your Whitelisted Redirection URLs for your Shopify app.
oauth2.ListenPort = 3017

'  The full content of the Authorization Endpoin for Shopify looks like this:
'  https://{shop}.myshopify.com/admin/oauth/authorize?client_id={api_key}&scope={scopes}&redirect_uri={redirect_uri}&state={nonce}&grant_options[]={option}

'  Replace "chilkat" with your shop name.
oauth2.AuthorizationEndpoint = "https://chilkat.myshopify.com/admin/oauth/authorize"
oauth2.TokenEndpoint = "https://chilkat.myshopify.com/admin/oauth/access_token"

'  Replace this with your actual API KEY (client ID)
oauth2.ClientId = "SHOPIFY_API_KEY"

'  This is for Require Proof Key for Code Exchange (PKCE)
'  See OAuth2 PKCE Explained
oauth2.CodeChallenge = True
oauth2.CodeChallengeMethod = "S256"

'  Set requested scopes.  See https://help.shopify.com/api/getting-started/authentication/oauth
oauth2.Scope = "read_product_listings,read_customers,read_orders,read_draft_orders"

'  Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
Dim url As String = oauth2.StartAuth
If oauth2.LastMethodSuccess <> True Then
    Log(oauth2.LastErrorText)
    Return
End If


'  Launch the default browser on the system and navigate to the url.
'  The LaunchBrowser method was added in Chilkat v10.1.2.
success = oauth2.LaunchBrowser(url)
If success = False Then
    Log(oauth2.LastErrorText)
    Return
End If


'  Wait for the user to approve or deny authorization in the browser.
Dim numMsWaited As Int = 0
Do While (numMsWaited < 90000) And (oauth2.AuthFlowState < 3)
    oauth2.SleepMs(100)
    numMsWaited = numMsWaited + 100
Loop

'  If the browser does not respond within the specified time, AuthFlowState will be:
'  
'  1: Waiting for Redirect – The OAuth2 background thread is waiting for the browser's redirect request.
'  2: Waiting for Final Response – The thread is awaiting the final access token response.
'  In either case, cancel the background task initiated by StartAuth.

If oauth2.AuthFlowState < 3 Then
    oauth2.Cancel
    Log("No response from the browser!")
    Return
End If


'  Check AuthFlowState to determine if authorization was granted, denied, or failed:
'  
'  3: Success – OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
'  4: Access Denied – OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
'  5: Failure – OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

If oauth2.AuthFlowState = 5 Then
    Log("OAuth2 failed to complete.")
    Log(oauth2.FailureInfo)
    Return
End If


If oauth2.AuthFlowState = 4 Then
    Log("OAuth2 authorization was denied.")
    Log(oauth2.AccessTokenResponse)
    Return
End If


If oauth2.AuthFlowState <> 3 Then
    Log("Unexpected AuthFlowState:" & oauth2.AuthFlowState)
    Return
End If


Log("OAuth2 authorization granted!")
Log("Access Token = " & oauth2.AccessToken)

'  Save the full JSON access token response to a file.
Dim sbJson As ChilkatStringBuilder
sbJson.Initialize
sbJson.Append(oauth2.AccessTokenResponse)
sbJson.WriteFile("qa_data/tokens/shopify-access-token.json", "utf-8", False)

'  The saved JSON response looks like this:

'  {
'    "access_token": "1364e43a5332583188cb27bc85469b1f",
'    "scope": "read_product_listings,read_customers,read_orders,read_draft_orders"
'  }