AutoIt

Get a Xero OAuth2 Access Token

See more OAuth2 Examples

Gets a Xero OAuth2 access token. AutoIt

Local $bSuccess = False

; For more information about the OAuth2, see OAuth 2.0 Authorization Flow

$oOauth2 = ObjCreate("Chilkat.OAuth2")

; 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.
$oOauth2.ListenPort = 55568

$oOauth2.AuthorizationEndpoint = "https://login.xero.com/identity/connect/authorize"
$oOauth2.TokenEndpoint = "https://identity.xero.com/connect/token"

; Replace these with actual values.
$oOauth2.ClientId = "XERO_APP_OAUTH2_CLIENT_ID"
$oOauth2.ClientSecret = "XERO_APP_OAUTH2_CLIENT_SECRET"
$oOauth2.UseBasicAuth = True

; 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..
$oOauth2.Scope = "openid profile email accounting.transactions accounting.attachments accounting.settings payroll.employees offline_access"

; Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
Local $sUrl = $oOauth2.StartAuth()
If ($oOauth2.LastMethodSuccess <> True) Then
    ConsoleWrite($oOauth2.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("url = " & $sUrl & @CRLF)

; Launch the default browser on the system and navigate to the url.
; The LaunchBrowser method was added in Chilkat v10.1.2.
$bSuccess = $oOauth2.LaunchBrowser($sUrl)
If ($bSuccess = False) Then
    ConsoleWrite($oOauth2.LastErrorText & @CRLF)
    Exit
EndIf

; Wait for the user to approve or deny authorization in the browser.
Local $iNumMsWaited = 0
While ($iNumMsWaited < 90000) And ($oOauth2.AuthFlowState < 3)
    $oOauth2.SleepMs 100
    $iNumMsWaited = $iNumMsWaited + 100
Wend

; 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 ($oOauth2.AuthFlowState < 3) Then
    $oOauth2.Cancel()
    ConsoleWrite("No response from the browser!" & @CRLF)
    Exit
EndIf

; 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 ($oOauth2.AuthFlowState = 5) Then
    ConsoleWrite("OAuth2 failed to complete." & @CRLF)
    ConsoleWrite($oOauth2.FailureInfo & @CRLF)
    Exit
EndIf

If ($oOauth2.AuthFlowState = 4) Then
    ConsoleWrite("OAuth2 authorization was denied." & @CRLF)
    ConsoleWrite($oOauth2.AccessTokenResponse & @CRLF)
    Exit
EndIf

If ($oOauth2.AuthFlowState <> 3) Then
    ConsoleWrite("Unexpected AuthFlowState:" & $oOauth2.AuthFlowState & @CRLF)
    Exit
EndIf

; Save the full JSON access token response to a file.
$oSbJson = ObjCreate("Chilkat.StringBuilder")
$oSbJson.Append($oOauth2.AccessTokenResponse)
$oSbJson.WriteFile("qa_data/tokens/xero-access-token.json","utf-8",False)

; The saved JSON response looks like this:

; 	{
; 	 "access_token": "...",
; 	 "token_type": "Bearer",
; 	 "expires_in": 3600,
; 	 "refresh_token": "..."
; 	}
; 
ConsoleWrite("OAuth2 authorization granted!" & @CRLF)
ConsoleWrite("Access Token = " & $oOauth2.AccessToken & @CRLF)