(Delphi DLL) Shopify OAuth2 Authentication

See more OAuth2 Examples

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

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, OAuth2, StringBuilder;

...

procedure TForm1.Button1Click(Sender: TObject);
var
oauth2: HCkOAuth2;
url: PWideChar;
success: Boolean;
numMsWaited: Integer;
sbJson: HCkStringBuilder;

begin
// To further clarify, see OAuth 2.0 Authorization Flow

oauth2 := CkOAuth2_Create();

// 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.
CkOAuth2_putListenPort(oauth2,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.
CkOAuth2_putAuthorizationEndpoint(oauth2,'https://chilkat.myshopify.com/admin/oauth/authorize');
CkOAuth2_putTokenEndpoint(oauth2,'https://chilkat.myshopify.com/admin/oauth/access_token');

// Replace this with your actual API KEY (client ID)
CkOAuth2_putClientId(oauth2,'SHOPIFY_API_KEY');

// This is for Require Proof Key for Code Exchange (PKCE)
// See OAuth2 PKCE Explained
CkOAuth2_putCodeChallenge(oauth2,True);
CkOAuth2_putCodeChallengeMethod(oauth2,'S256');

// Set requested scopes.  See https://help.shopify.com/api/getting-started/authentication/oauth
CkOAuth2_putScope(oauth2,'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 := CkOAuth2__startAuth(oauth2);
if (CkOAuth2_getLastMethodSuccess(oauth2) <> True) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
success := CkOAuth2_LaunchBrowser(oauth2,url);
if (success = False) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

// Wait for the user to approve or deny authorization in the browser.
numMsWaited := 0;
while (numMsWaited < 90000) and (CkOAuth2_getAuthFlowState(oauth2) < 3) do
  begin
    CkOAuth2_SleepMs(oauth2,100);
    numMsWaited := numMsWaited + 100;
  end;

// 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 (CkOAuth2_getAuthFlowState(oauth2) < 3) then
  begin
    CkOAuth2_Cancel(oauth2);
    Memo1.Lines.Add('No response from the browser!');
    Exit;
  end;

// 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 (CkOAuth2_getAuthFlowState(oauth2) = 5) then
  begin
    Memo1.Lines.Add('OAuth2 failed to complete.');
    Memo1.Lines.Add(CkOAuth2__failureInfo(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) = 4) then
  begin
    Memo1.Lines.Add('OAuth2 authorization was denied.');
    Memo1.Lines.Add(CkOAuth2__accessTokenResponse(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) <> 3) then
  begin
    Memo1.Lines.Add('Unexpected AuthFlowState:' + IntToStr(CkOAuth2_getAuthFlowState(oauth2)));
    Exit;
  end;

Memo1.Lines.Add('OAuth2 authorization granted!');
Memo1.Lines.Add('Access Token = ' + CkOAuth2__accessToken(oauth2));

// Save the full JSON access token response to a file.
sbJson := CkStringBuilder_Create();
CkStringBuilder_Append(sbJson,CkOAuth2__accessTokenResponse(oauth2));
CkStringBuilder_WriteFile(sbJson,'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"
// }

CkOAuth2_Dispose(oauth2);
CkStringBuilder_Dispose(sbJson);

end;