Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Tcl Web API Examples

Primary Categories

AWS Translate
Activix CRM
Adyen
Amazon MWS
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Bluzone
CardConnect
ClickBank
Clickatell
Cloudfare
DocuSign
ETrade
Etsy
Facebook
GeoOp
GetHarvest
Jira
MYOB

Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Okta OAuth/OIDC
OneLogin OIDC
PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shippo
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Vonage
Walmart
Walmart v3
Xero
eBay
effectconnect

 

 

 

(Tcl) Quickbooks OAuth1 Authorization (3-legged)

Demonstrates 3-legged OAuth1 authorization for Quickbooks.

Chilkat Tcl Extension Downloads

Chilkat Tcl Extension Downloads

load ./chilkat.dll

set consumerKey "QUICKBOOKS_CONSUMER_KEY"
set consumerSecret "QUICKBOOKS_CONSUMER_SECRET"

set requestTokenUrl "https://oauth.intuit.com/oauth/v1/get_request_token"
set authorizeUrl "https://appcenter.intuit.com/Connect/Begin"
set accessTokenUrl "https://oauth.intuit.com/oauth/v1/get_access_token"

# The port number is picked at random. It's some unused port that won't likely conflict with anything else..
set callbackUrl "http://localhost:3017/"
set callbackLocalPort 3017

# The 1st step in 3-legged OAuth1.0a is to send a POST to the request token URL to obtain an OAuth Request Token
set http [new_CkHttp]

CkHttp_put_OAuth1 $http 1
CkHttp_put_OAuthConsumerKey $http $consumerKey
CkHttp_put_OAuthConsumerSecret $http $consumerSecret
CkHttp_put_OAuthCallback $http $callbackUrl

set req [new_CkHttpRequest]

# resp is a CkHttpResponse
set resp [CkHttp_PostUrlEncoded $http $requestTokenUrl $req]
if {[expr [CkHttp_get_LastMethodSuccess $http] != 1]} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

if {[expr [CkHttpResponse_get_StatusCode $resp] >= 400]} then {
    puts "Error response status code = [CkHttpResponse_get_StatusCode $resp]"
    puts [CkHttpResponse_bodyStr $resp]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

# If successful, the resp.BodyStr contains this:  
# oauth_token=-Wa_KwAAAAAAxfEPAAABV8Qar4Q&oauth_token_secret=OfHY4tZBX2HK4f7yIw76WYdvnl99MVGB&oauth_callback_confirmed=true
puts [CkHttpResponse_bodyStr $resp]

set hashTab1 [new_CkHashtable]

CkHashtable_AddQueryParams $hashTab1 [CkHttpResponse_bodyStr $resp]

set requestToken [CkHashtable_lookupStr $hashTab1 "oauth_token"]
set requestTokenSecret [CkHashtable_lookupStr $hashTab1 "oauth_token_secret"]
CkHttp_put_OAuthTokenSecret $http $requestTokenSecret

delete_CkHttpResponse $resp

puts "oauth_token = $requestToken"
puts "oauth_token_secret = $requestTokenSecret"

# ---------------------------------------------------------------------------
# The next step is to form a URL to send to the AuthorizeUrl
# This is an HTTP GET that we load into a popup browser.
set sbUrlForBrowser [new_CkStringBuilder]

CkStringBuilder_Append $sbUrlForBrowser $authorizeUrl
CkStringBuilder_Append $sbUrlForBrowser "?oauth_token="
CkStringBuilder_Append $sbUrlForBrowser $requestToken
set urlForBrowser [CkStringBuilder_getAsString $sbUrlForBrowser]

# When the urlForBrowser is loaded into a browser, the response from Quickbooks will redirect back to localhost:3017
# We'll need to start a socket that is listening on port 3017 for the callback from the browser.
set listenSock [new_CkSocket]

set backLog 5
set success [CkSocket_BindAndListen $listenSock $callbackLocalPort $backLog]
if {[expr $success != 1]} then {
    puts [CkSocket_lastErrorText $listenSock]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHashtable $hashTab1
    delete_CkStringBuilder $sbUrlForBrowser
    delete_CkSocket $listenSock
    exit
}

# Wait for the browser's connection in a background thread.
# (We'll send load the URL into the browser following this..)
# Wait a max of 60 seconds before giving up.
set maxWaitMs 60000
# task is a CkTask
set task [CkSocket_AcceptNextConnectionAsync $listenSock $maxWaitMs]
CkTask_Run $task

#  At this point, your application should load the URL in a browser.
#  For example,
#  in C#:  System.Diagnostics.Process.Start(urlForBrowser);
#  in Java: Desktop.getDesktop().browse(new URI(urlForBrowser));
#  in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
#               wsh.Run urlForBrowser
#  The Quickbooks account owner would interactively accept or deny the authorization request.

#  Add the code to load the url in a web browser here...
#  Add the code to load the url in a web browser here...
#  Add the code to load the url in a web browser here...
# System.Diagnostics.Process.Start(urlForBrowser);

# Wait for the listenSock's task to complete.
set success [CkTask_Wait $task $maxWaitMs]
if {[expr !$success OR [expr [expr [CkTask_get_StatusInt $task] != 7] OR [expr [CkTask_get_TaskSuccess $task] != 1]]]} then {
    if {!$success} then {
        # The task.LastErrorText applies to the Wait method call.
        puts [CkTask_lastErrorText $task]
    }     else {
        # The ResultErrorText applies to the underlying task method call (i.e. the AcceptNextConnection)
        puts [CkTask_status $task]
        puts [CkTask_resultErrorText $task]
    }

    delete_CkTask $task

    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHashtable $hashTab1
    delete_CkStringBuilder $sbUrlForBrowser
    delete_CkSocket $listenSock
    exit
}

# If we get to this point, the connection from the browser arrived and was accepted.

# We no longer need the listen socket...
# Close it so that it's no longer listening on port 3017.
CkSocket_Close $listenSock 10

# The first thing to do is to get the connected socket.
set sock [new_CkSocket]

CkSocket_LoadTaskResult $sock $task
delete_CkTask $task

# Read the start line of the request..
set startLine [CkSocket_receiveUntilMatch $sock "\r\n"]
if {[expr [CkSocket_get_LastMethodSuccess $sock] != 1]} then {
    puts [CkSocket_lastErrorText $sock]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHashtable $hashTab1
    delete_CkStringBuilder $sbUrlForBrowser
    delete_CkSocket $listenSock
    delete_CkSocket $sock
    exit
}

# Read the request header.
set requestHeader [CkSocket_receiveUntilMatch $sock "\r\n\r\n"]
if {[expr [CkSocket_get_LastMethodSuccess $sock] != 1]} then {
    puts [CkSocket_lastErrorText $sock]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHashtable $hashTab1
    delete_CkStringBuilder $sbUrlForBrowser
    delete_CkSocket $listenSock
    delete_CkSocket $sock
    exit
}

# The browser SHOULD be sending us a GET request, and therefore there is no body to the request.
# Once the request header is received, we have all of it.
# We can now send our HTTP response.
set sbResponseHtml [new_CkStringBuilder]

CkStringBuilder_Append $sbResponseHtml "<html><body><p>Chilkat thanks you!</b></body</html>"

set sbResponse [new_CkStringBuilder]

CkStringBuilder_Append $sbResponse "HTTP/1.1 200 OK\r\n"
CkStringBuilder_Append $sbResponse "Content-Length: "
CkStringBuilder_AppendInt $sbResponse [CkStringBuilder_get_Length $sbResponseHtml]
CkStringBuilder_Append $sbResponse "\r\n"
CkStringBuilder_Append $sbResponse "Content-Type: text/html\r\n"
CkStringBuilder_Append $sbResponse "\r\n"
CkStringBuilder_AppendSb $sbResponse $sbResponseHtml

CkSocket_SendString $sock [CkStringBuilder_getAsString $sbResponse]
CkSocket_Close $sock 50

# The information we need is in the startLine.
# For example, the startLine will look like this:
#  GET /?oauth_token=abcdRQAAZZAAxfBBAAABVabcd_k&oauth_verifier=9rdOq5abcdCe6cn8M3jabcdj3Eabcd HTTP/1.1
set sbStartLine [new_CkStringBuilder]

CkStringBuilder_Append $sbStartLine $startLine
set numReplacements [CkStringBuilder_Replace $sbStartLine "GET /?" ""]
set numReplacements [CkStringBuilder_Replace $sbStartLine " HTTP/1.1" ""]
CkStringBuilder_Trim $sbStartLine

# oauth_token=qyprdP04IrTDIXtP1HRZz0geQdjXHVlGDxXPexlXZsjZNRcY&oauth_verifier=arx5pj5&realmId=193514465596199&dataSource=QBO
puts "startline: [CkStringBuilder_getAsString $sbStartLine]"

CkHashtable_Clear $hashTab1
CkHashtable_AddQueryParams $hashTab1 [CkStringBuilder_getAsString $sbStartLine]

set requestToken [CkHashtable_lookupStr $hashTab1 "oauth_token"]
set authVerifier [CkHashtable_lookupStr $hashTab1 "oauth_verifier"]

# ------------------------------------------------------------------------------
# Finally , we must exchange the OAuth Request Token for an OAuth Access Token.

CkHttp_put_OAuthToken $http $requestToken
CkHttp_put_OAuthVerifier $http $authVerifier
set resp [CkHttp_PostUrlEncoded $http $accessTokenUrl $req]
if {[expr [CkHttp_get_LastMethodSuccess $http] != 1]} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHashtable $hashTab1
    delete_CkStringBuilder $sbUrlForBrowser
    delete_CkSocket $listenSock
    delete_CkSocket $sock
    delete_CkStringBuilder $sbResponseHtml
    delete_CkStringBuilder $sbResponse
    delete_CkStringBuilder $sbStartLine
    exit
}

# Make sure a successful response was received.
if {[expr [CkHttpResponse_get_StatusCode $resp] != 200]} then {
    puts [CkHttpResponse_statusLine $resp]
    puts [CkHttpResponse_header $resp]
    puts [CkHttpResponse_bodyStr $resp]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHashtable $hashTab1
    delete_CkStringBuilder $sbUrlForBrowser
    delete_CkSocket $listenSock
    delete_CkSocket $sock
    delete_CkStringBuilder $sbResponseHtml
    delete_CkStringBuilder $sbResponse
    delete_CkStringBuilder $sbStartLine
    exit
}

# If successful, the resp.BodyStr contains something like this:
# oauth_token=12347455-ffffrrlaBdCjbdGfyjZabcdb5APNtuTPNabcdEpp&oauth_token_secret=RxxxxJ8mTzUhwES4xxxxuJyFWDN8ZfHmrabcddh88LmWE
puts [CkHttpResponse_bodyStr $resp]

set hashTab2 [new_CkHashtable]

CkHashtable_AddQueryParams $hashTab2 [CkHttpResponse_bodyStr $resp]

set accessToken [CkHashtable_lookupStr $hashTab2 "oauth_token"]
set accessTokenSecret [CkHashtable_lookupStr $hashTab2 "oauth_token_secret"]

delete_CkHttpResponse $resp

# The access token + secret is what should be saved and used for
# subsequent REST API calls.
puts "Access Token = $accessToken"
puts "Access Token Secret = $accessTokenSecret"

# Save this access token for future calls.
set json [new_CkJsonObject]

CkJsonObject_AppendString $json "oauth_token" $accessToken
CkJsonObject_AppendString $json "oauth_token_secret" $accessTokenSecret

# Also save the realmId and dataSource from hashTab1.
set realmId [CkHashtable_lookupStr $hashTab1 "realmId"]
puts "realmId = $realmId"
set dataSource [CkHashtable_lookupStr $hashTab1 "dataSource"]
puts "dataSource = $dataSource"

CkJsonObject_AppendString $json "realmId" $realmId
CkJsonObject_AppendString $json "dataSource" $dataSource

set fac [new_CkFileAccess]

CkFileAccess_WriteEntireTextFile $fac "qa_data/tokens/quickbooks.json" [CkJsonObject_emit $json] "utf-8" 0

puts "Success."

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkHashtable $hashTab1
delete_CkStringBuilder $sbUrlForBrowser
delete_CkSocket $listenSock
delete_CkSocket $sock
delete_CkStringBuilder $sbResponseHtml
delete_CkStringBuilder $sbResponse
delete_CkStringBuilder $sbStartLine
delete_CkHashtable $hashTab2
delete_CkJsonObject $json
delete_CkFileAccess $fac

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.