Perl 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. Perl

use chilkat();

$success = 0;

#  To further clarify, see OAuth 2.0 Authorization Flow

$oauth2 = chilkat::CkOAuth2->new();

#  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->put_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->put_AuthorizationEndpoint("https://chilkat.myshopify.com/admin/oauth/authorize");
$oauth2->put_TokenEndpoint("https://chilkat.myshopify.com/admin/oauth/access_token");

#  Replace this with your actual API KEY (client ID)
$oauth2->put_ClientId("SHOPIFY_API_KEY");

#  This is for Require Proof Key for Code Exchange (PKCE)
#  See OAuth2 PKCE Explained
$oauth2->put_CodeChallenge(1);
$oauth2->put_CodeChallengeMethod("S256");

#  Set requested scopes.  See https://help.shopify.com/api/getting-started/authentication/oauth
$oauth2->put_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.
$url = $oauth2->startAuth();
if ($oauth2->get_LastMethodSuccess() != 1) {
    print $oauth2->lastErrorText() . "\r\n";
    exit;
}

#  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 == 0) {
    print $oauth2->lastErrorText() . "\r\n";
    exit;
}

#  Wait for the user to approve or deny authorization in the browser.
$numMsWaited = 0;
while (($numMsWaited < 90000) and ($oauth2->get_AuthFlowState() < 3)) {
    $oauth2->SleepMs(100);
    $numMsWaited = $numMsWaited + 100;
}

#  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->get_AuthFlowState() < 3) {
    $oauth2->Cancel();
    print "No response from the browser!" . "\r\n";
    exit;
}

#  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->get_AuthFlowState() == 5) {
    print "OAuth2 failed to complete." . "\r\n";
    print $oauth2->failureInfo() . "\r\n";
    exit;
}

if ($oauth2->get_AuthFlowState() == 4) {
    print "OAuth2 authorization was denied." . "\r\n";
    print $oauth2->accessTokenResponse() . "\r\n";
    exit;
}

if ($oauth2->get_AuthFlowState() != 3) {
    print "Unexpected AuthFlowState:" . $oauth2->get_AuthFlowState() . "\r\n";
    exit;
}

print "OAuth2 authorization granted!" . "\r\n";
print "Access Token = " . $oauth2->accessToken() . "\r\n";

#  Save the full JSON access token response to a file.
$sbJson = chilkat::CkStringBuilder->new();
$sbJson->Append($oauth2->accessTokenResponse());
$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"
#  }