(PowerBuilder) 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.

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Oauth2
string ls_Url
integer li_Success
integer li_NumMsWaited
oleobject loo_SbJson

// To further clarify, see OAuth 2.0 Authorization Flow

loo_Oauth2 = create oleobject
// Use "Chilkat_9_5_0.OAuth2" for versions of Chilkat < 10.0.0
li_rc = loo_Oauth2.ConnectToNewObject("Chilkat.OAuth2")
if li_rc < 0 then
    destroy loo_Oauth2
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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.
loo_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.
loo_Oauth2.AuthorizationEndpoint = "https://chilkat.myshopify.com/admin/oauth/authorize"
loo_Oauth2.TokenEndpoint = "https://chilkat.myshopify.com/admin/oauth/access_token"

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

// This is for Require Proof Key for Code Exchange (PKCE)
// See OAuth2 PKCE Explained
loo_Oauth2.CodeChallenge = 1
loo_Oauth2.CodeChallengeMethod = "S256"

// Set requested scopes.  See https://help.shopify.com/api/getting-started/authentication/oauth
loo_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.
ls_Url = loo_Oauth2.StartAuth()
if loo_Oauth2.LastMethodSuccess <> 1 then
    Write-Debug loo_Oauth2.LastErrorText
    destroy loo_Oauth2
    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.
li_Success = loo_Oauth2.LaunchBrowser(ls_Url)
if li_Success = 0 then
    Write-Debug loo_Oauth2.LastErrorText
    destroy loo_Oauth2
    return
end if

// Wait for the user to approve or deny authorization in the browser.
li_NumMsWaited = 0
do while (li_NumMsWaited < 90000) AND (loo_Oauth2.AuthFlowState < 3)
    loo_Oauth2.SleepMs(100)
    li_NumMsWaited = li_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 loo_Oauth2.AuthFlowState < 3 then
    loo_Oauth2.Cancel()
    Write-Debug "No response from the browser!"
    destroy loo_Oauth2
    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 loo_Oauth2.AuthFlowState = 5 then
    Write-Debug "OAuth2 failed to complete."
    Write-Debug loo_Oauth2.FailureInfo
    destroy loo_Oauth2
    return
end if

if loo_Oauth2.AuthFlowState = 4 then
    Write-Debug "OAuth2 authorization was denied."
    Write-Debug loo_Oauth2.AccessTokenResponse
    destroy loo_Oauth2
    return
end if

if loo_Oauth2.AuthFlowState <> 3 then
    Write-Debug "Unexpected AuthFlowState:" + string(loo_Oauth2.AuthFlowState)
    destroy loo_Oauth2
    return
end if

Write-Debug "OAuth2 authorization granted!"
Write-Debug "Access Token = " + loo_Oauth2.AccessToken

// Save the full JSON access token response to a file.
loo_SbJson = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbJson.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbJson.Append(loo_Oauth2.AccessTokenResponse)
loo_SbJson.WriteFile("qa_data/tokens/shopify-access-token.json","utf-8",0)

// The saved JSON response looks like this:

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


destroy loo_Oauth2
destroy loo_SbJson