CkPython

GetHarvest API V2 OAuth Token

See more GetHarvest Examples

Demonstrates how to get an OAuth2 access token for the GetHarvest v2 API (from a desktop application). CkPython

import sys
import chilkat

success = False

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

oauth2 = chilkat.CkOAuth2()

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

oauth2.put_AuthorizationEndpoint("https://id.getharvest.com/oauth2/authorize")
oauth2.put_TokenEndpoint("https://id.getharvest.com/api/v2/oauth2/token")

# Replace these with actual values.
oauth2.put_ClientId("CLIENT_ID")
oauth2.put_ClientSecret("CLIENT_SECRET")

oauth2.put_CodeChallenge(False)

oauth2.put_Scope("all")

# Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
url = oauth2.startAuth()
if (oauth2.get_LastMethodSuccess() == False):
    print(oauth2.lastErrorText())
    sys.exit()

# Launch the system's default browser navigated to the URL.
success = oauth2.LaunchBrowser(url)
if (success == False):
    print(oauth2.lastErrorText())
    sys.exit()

# Now wait for the authorization.
# We'll wait for a max of 60 seconds.
numMsWaited = 0
while (numMsWaited < 60000) and (oauth2.get_AuthFlowState() < 3) :
    oauth2.SleepMs(100)
    numMsWaited = numMsWaited + 100

# 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.get_AuthFlowState() < 3):
    oauth2.Cancel()
    print("No response from the browser!")
    sys.exit()

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

print("OAuth2 authorization granted!")
print("Access Token = " + oauth2.accessToken())

# Get the full JSON response:
json = chilkat.CkJsonObject()
json.Load(oauth2.accessTokenResponse())
json.put_EmitCompact(False)
print(json.emit())

# The JSON response looks like this:

# Save the JSON to a file for future requests.
fac = chilkat.CkFileAccess()
fac.WriteEntireTextFile("qa_data/tokens/getHarvest.json",json.emit(),"utf-8",False)