(CkPython) Get a Xero OAuth2 Access Token

Gets a Xero OAuth2 access token.

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

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux

import sys
import chilkat

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

oauth2 = chilkat.CkOAuth2()

# 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.put_ListenPort(55568)

oauth2.put_AuthorizationEndpoint("https://login.xero.com/identity/connect/authorize")
oauth2.put_TokenEndpoint("https://identity.xero.com/connect/token")

# Replace these with actual values.
oauth2.put_ClientId("XERO_APP_OAUTH2_CLIENT_ID")
oauth2.put_ClientSecret("XERO_APP_OAUTH2_CLIENT_SECRET")
oauth2.put_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..
oauth2.put_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.
url = oauth2.startAuth()
if (oauth2.get_LastMethodSuccess() != True):
    print(oauth2.lastErrorText())
    sys.exit()

print("url = " + url)

# 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 == False):
    print(oauth2.lastErrorText())
    sys.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!")
    sys.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.")
    print(oauth2.failureInfo())
    sys.exit()

if (oauth2.get_AuthFlowState() == 4):
    print("OAuth2 authorization was denied.")
    print(oauth2.accessTokenResponse())
    sys.exit()

if (oauth2.get_AuthFlowState() != 3):
    print("Unexpected AuthFlowState:" + str(oauth2.get_AuthFlowState()))
    sys.exit()

# Save the full JSON access token response to a file.
sbJson = chilkat.CkStringBuilder()
sbJson.Append(oauth2.accessTokenResponse())
sbJson.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": "..."
# 	}
# 
print("OAuth2 authorization granted!")
print("Access Token = " + oauth2.accessToken())