Tcl Requires Chilkat v10.1.3+

Datev OAuth2 Access Token

See more Datev Examples

Demonstrates how to get a Datev OAuth2 access token from a desktop application or script. Tcl

load ./chilkat.dll

set success 0

#  To further clarify, see OAuth 2.0 Authorization Flow

set oauth2 [new_CkOAuth2]

#  Your Datev app should use "http://localhost" (no trailing forward slash) for the redirect URL.
CkOAuth2_put_ListenPort $oauth2 3017

#  

CkOAuth2_put_AuthorizationEndpoint $oauth2 "https://login.datev.de/openidsandbox/authorize"
CkOAuth2_put_TokenEndpoint $oauth2 "https://sandbox-api.datev.de/token"

#  Replace this with your actual client ID.
CkOAuth2_put_ClientId $oauth2 "DATEV_CLIENT_ID"
CkOAuth2_put_ClientSecret $oauth2 "DATEV_CLIENT_SECRET"

CkOAuth2_put_CodeChallenge $oauth2 1
CkOAuth2_put_CodeChallengeMethod $oauth2 "S256"

CkOAuth2_put_Scope $oauth2 "openid profile email datev:accounting:clients accounting:documents datev:accounting:extf-files-import"

#  Begin the OAuth2 authorization code flow.  This returns a URL that should be loaded in a browser.
set url [CkOAuth2_startAuth $oauth2]
if {[CkOAuth2_get_LastMethodSuccess $oauth2] != 1} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

#  Launch the default browser on the system and navigate to the url.
#  The LaunchBrowser method was added in Chilkat v10.1.2.
set success [CkOAuth2_LaunchBrowser $oauth2 $url]
if {$success == 0} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

#  Wait for the interactive user to grant permission in the interactive browser session.
#  We'll wait for a max of 90 seconds.
set numMsWaited 0
while {expr [$numMsWaited < 90000]  &&  [[CkOAuth2_get_AuthFlowState $oauth2] < 3]} {
    CkOAuth2_SleepMs $oauth2 100
    set numMsWaited [expr $numMsWaited + 100]
}

#  If there was no response from the browser within 90 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 {[CkOAuth2_get_AuthFlowState $oauth2] < 3} then {
    CkOAuth2_Cancel $oauth2
    puts "No response from the browser!"
    delete_CkOAuth2 $oauth2
    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 {[CkOAuth2_get_AuthFlowState $oauth2] == 5} then {
    puts "OAuth2 failed to complete."
    puts [CkOAuth2_failureInfo $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] == 4} then {
    puts "OAuth2 authorization was denied."
    puts [CkOAuth2_accessTokenResponse $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] != 3} then {
    puts "Unexpected AuthFlowState:[CkOAuth2_get_AuthFlowState $oauth2]"
    delete_CkOAuth2 $oauth2
    exit
}

#  Save the full JSON access token response to a file.
set sbJson [new_CkStringBuilder]

CkStringBuilder_Append $sbJson [CkOAuth2_accessTokenResponse $oauth2]
CkStringBuilder_WriteFile $sbJson "qa_data/tokens/datev.json" "utf-8" 0

#  The saved JSON response looks like this:

#  {
#  	"refresh_token": "ZDA5Y .... FFhTXc9",
#  	"refresh_token_expires_in": 39600,
#  	"id_token": "eyJ .... Q9w",
#  	"access_token": "MTM .... 1UDA9",
#  	"token_type": "bearer",
#  	"expires_in": 900		
#  }

puts "OAuth2 authorization granted!"
puts "Access Token = [CkOAuth2_accessToken $oauth2]"

delete_CkOAuth2 $oauth2
delete_CkStringBuilder $sbJson