Lua Requires Chilkat v10.1.3+
Lua
Datev OAuth2 Access Token
See more Datev Examples
Demonstrates how to get a Datev OAuth2 access token from a desktop application or script.Chilkat Lua Downloads
local chilkat = require("chilkat")
-- To further clarify, see OAuth 2.0 Authorization Flow
local oauth2 = chilkat.OAuth2.new()
-- Your Datev app should use "http://localhost" (no trailing forward slash) for the redirect URL.
oauth2.listen_port = 3017
--
oauth2.authorization_endpoint = "https://login.datev.de/openidsandbox/authorize"
oauth2.token_endpoint = "https://sandbox-api.datev.de/token"
-- Replace this with your actual client ID.
oauth2.client_id = "DATEV_CLIENT_ID"
oauth2.client_secret = "DATEV_CLIENT_SECRET"
oauth2.code_challenge = true
oauth2.code_challenge_method = "S256"
oauth2.scope = "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.
local url = oauth2:start_auth()
if not oauth2.last_method_success then
print(oauth2.last_error_text)
return
end
-- Launch the default browser on the system and navigate to the url.
local success = oauth2:launch_browser(url)
if not success then
print(oauth2.last_error_text)
return
end
-- Wait for the interactive user to grant permission in the interactive browser session.
-- We'll wait for a max of 90 seconds.
local numMsWaited = 0
while (numMsWaited < 90000) and (oauth2.auth_flow_state < 3) do
oauth2:sleep_ms(100)
numMsWaited = numMsWaited + 100
end
-- 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 oauth2.auth_flow_state < 3 then
oauth2:cancel()
print("No response from the browser!")
return
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.auth_flow_state == 5 then
print("OAuth2 failed to complete.")
print(oauth2.failure_info)
return
end
if oauth2.auth_flow_state == 4 then
print("OAuth2 authorization was denied.")
print(oauth2.access_token_response)
return
end
if oauth2.auth_flow_state ~= 3 then
print("Unexpected AuthFlowState:" .. oauth2.auth_flow_state)
return
end
-- Save the full JSON access token response to a file.
local sbJson = chilkat.StringBuilder.new()
sbJson:append(oauth2.access_token_response)
sbJson:write_file("qa_data/tokens/datev.json", "utf-8", false)
-- 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
-- }
print("OAuth2 authorization granted!")
print("Access Token = " .. oauth2.access_token)