(Delphi ActiveX) Get a Xero OAuth2 Access Token

Gets a Xero OAuth2 access token.

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

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
oauth2: TChilkatOAuth2;
success: Integer;
url: WideString;
numMsWaited: Integer;
sbJson: TChilkatStringBuilder;

begin
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

oauth2 := TChilkatOAuth2.Create(Self);

// For Xero OAuth2, set the listen port equal to the port used
// in the Authorized Redirect URL for the Client ID.
// For example, in this case the Authorized Redirect URL would be http://localhost:55568/
// Your app should choose a port not likely not used by any other application.
// See Xero OAuth2 for Desktop Apps for more information.
oauth2.ListenPort := 55568;

oauth2.AuthorizationEndpoint := 'https://login.xero.com/identity/connect/authorize';
oauth2.TokenEndpoint := 'https://identity.xero.com/connect/token';

// Replace these with actual values.
oauth2.ClientId := 'XERO_APP_OAUTH2_CLIENT_ID';
oauth2.ClientSecret := 'XERO_APP_OAUTH2_CLIENT_SECRET';
oauth2.UseBasicAuth := 1;

// See https://developer.xero.com/documentation/oauth2/scopes for a complete list of scopes.
// You will need to change the scopes depending on what access is needed..
oauth2.Scope := 'openid profile email accounting.transactions accounting.attachments accounting.settings payroll.employees offline_access';

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
url := oauth2.StartAuth();
if (oauth2.LastMethodSuccess <> 1) then
  begin
    Memo1.Lines.Add(oauth2.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add('URL: ' + url);

// At this point, your application should load the URL in a browser.
// For example, 
// in C#: System.Diagnostics.Process.Start(url);
// in Java: Desktop.getDesktop().browse(new URI(url));
// in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
//              wsh.Run url
// in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
// in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
// in dBASE: run(false, 'rundll32 url.dll,FileProtocolHandler "' + lcUrl + '"')
// The Google account owner would interactively accept or deny the authorization request.

// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...
// System.Diagnostics.Process.Start(url);

// Now wait for the authorization.
// We'll wait for a max of 60 seconds.
numMsWaited := 0;
while (numMsWaited < 60000) and (oauth2.AuthFlowState < 3) do
  begin
    oauth2.SleepMs(100);
    numMsWaited := numMsWaited + 100;
  end;

// If there was no response from the browser within 30 seconds, then 
// the AuthFlowState will be equal to 1 or 2.
// 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
// 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
// In that case, cancel the background task started in the call to StartAuth.
if (oauth2.AuthFlowState < 3) then
  begin
    oauth2.Cancel();
    Memo1.Lines.Add('No response from the browser!');
    Exit;
  end;

// Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
// The possible AuthFlowState values are:
// 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
// 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
// 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
if (oauth2.AuthFlowState = 5) then
  begin
    Memo1.Lines.Add('OAuth2 failed to complete.');
    Memo1.Lines.Add(oauth2.FailureInfo);
    Exit;
  end;

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

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

// Save the full JSON access token response to a file.
sbJson := TChilkatStringBuilder.Create(Self);
sbJson.Append(oauth2.AccessTokenResponse);
sbJson.WriteFile('qa_data/tokens/xero-access-token.json','utf-8',0);

// The saved JSON response looks like this:

// 	{
// 	 "access_token": "...",
// 	 "token_type": "Bearer",
// 	 "expires_in": 3600,
// 	 "refresh_token": "..."
// 	}
// 
Memo1.Lines.Add('OAuth2 authorization granted!');
Memo1.Lines.Add('Access Token = ' + oauth2.AccessToken);
end;