Lua Requires Chilkat v11.0.0+
Lua
Quickbooks OAuth1 Authorization (3-legged)
See more QuickBooks Examples
Demonstrates 3-legged OAuth1 authorization for Quickbooks.Chilkat Lua Downloads
-- In the following call to loadlib, change the path (./chilkat.dll) to the relative or absolute directory where the chilkat.dll, chilkat.so, or chilkat.dylib is located.
chilkat = assert(package.loadlib("./chilkat.dll", "luaopen_chilkat"))()
print(chilkat._VERSION)
local success = false
local consumerKey = "QUICKBOOKS_CONSUMER_KEY"
local consumerSecret = "QUICKBOOKS_CONSUMER_SECRET"
local requestTokenUrl = "https://oauth.intuit.com/oauth/v1/get_request_token"
local authorizeUrl = "https://appcenter.intuit.com/Connect/Begin"
local 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..
local callbackUrl = "http://localhost:3017/"
local 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
local http = chilkat.newHttp{}
http:setOAuth1(true)
http:setOAuthConsumerKey(consumerKey)
http:setOAuthConsumerSecret(consumerSecret)
http:setOAuthCallback(callbackUrl)
local req = chilkat.newHttpRequest{}
req:setHttpVerb("POST")
req:setContentType("application/x-www-form-urlencoded")
local resp = chilkat.newHttpResponse{}
success = http:HttpReq(requestTokenUrl,req,resp)
if success == false then
print(http:LastErrorText())
end
if resp:StatusCode() >= 400 then
print("Error response status code = ", resp:StatusCode())
print(resp:BodyStr())
end
-- If successful, the resp.BodyStr contains this:
-- oauth_token=-Wa_KwAAAAAAxfEPAAABV8Qar4Q&oauth_token_secret=OfHY4tZBX2HK4f7yIw76WYdvnl99MVGB&oauth_callback_confirmed=true
print(resp:BodyStr())
local hashTab1 = chilkat.newHashtable{}
hashTab1:AddQueryParams(resp:BodyStr())
local requestToken = hashTab1:LookupStr("oauth_token")
local requestTokenSecret = hashTab1:LookupStr("oauth_token_secret")
http:setOAuthTokenSecret(requestTokenSecret)
print("oauth_token = ", requestToken)
print("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.
local sbUrlForBrowser = chilkat.newStringBuilder{}
sbUrlForBrowser:Append(authorizeUrl)
sbUrlForBrowser:Append("?oauth_token=")
sbUrlForBrowser:Append(requestToken)
local url = sbUrlForBrowser:GetAsString()
-- 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.
local listenSock = chilkat.newSocket{}
local backLog = 5
success = listenSock:BindAndListen(callbackLocalPort,backLog)
if success == false then
print(listenSock:LastErrorText())
end
-- 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.
local sock = chilkat.newSocket{}
local maxWaitMs = 60000
local task = listenSock:AcceptNextAsync(maxWaitMs,sock)
task:Run()
-- Launch the system's default browser navigated to the URL.
local oauth2 = chilkat.newOAuth2{}
success = oauth2:LaunchBrowser(url)
if success == false then
print(oauth2:LastErrorText())
end
-- Wait for the listenSock's task to complete.
success = task:Wait(maxWaitMs)
if !success || (task:StatusInt() ~= 7) || (task:TaskSuccess() ~= true) then
if !success then
-- The task.LastErrorText applies to the Wait method call.
print(task:LastErrorText())
else
-- The ResultErrorText applies to the underlying task method call (i.e. the AcceptNextConnection)
print(task:Status())
print(task:ResultErrorText())
end
end
-- 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.
listenSock:Close(10)
-- Read the start line of the request..
local startLine = sock:ReceiveUntilMatch("\r\n")
if sock:LastMethodSuccess() == false then
print(sock:LastErrorText())
end
-- Read the request header.
local requestHeader = sock:ReceiveUntilMatch("\r\n\r\n")
if sock:LastMethodSuccess() == false then
print(sock:LastErrorText())
end
-- 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.
local sbResponseHtml = chilkat.newStringBuilder{}
sbResponseHtml:Append("<html><body><p>Chilkat thanks you!</b></body</html>")
local sbResponse = chilkat.newStringBuilder{}
sbResponse:Append("HTTP/1.1 200 OK\r\n")
sbResponse:Append("Content-Length: ")
sbResponse:AppendInt(sbResponseHtml:Length())
sbResponse:Append("\r\n")
sbResponse:Append("Content-Type: text/html\r\n")
sbResponse:Append("\r\n")
sbResponse:AppendSb(sbResponseHtml)
sock:SendString(sbResponse:GetAsString())
sock:Close(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
local sbStartLine = chilkat.newStringBuilder{}
sbStartLine:Append(startLine)
local numReplacements = sbStartLine:Replace("GET /?","")
numReplacements = sbStartLine:Replace(" HTTP/1.1","")
sbStartLine:Trim()
-- oauth_token=qyprdP04IrTDIXtP1HRZz0geQdjXHVlGDxXPexlXZsjZNRcY&oauth_verifier=arx5pj5&realmId=193514465596199&dataSource=QBO
print("startline: ", sbStartLine:GetAsString())
hashTab1:Clear()
hashTab1:AddQueryParams(sbStartLine:GetAsString())
requestToken = hashTab1:LookupStr("oauth_token")
local authVerifier = hashTab1:LookupStr("oauth_verifier")
-- ------------------------------------------------------------------------------
-- Finally , we must exchange the OAuth Request Token for an OAuth Access Token.
http:setOAuthToken(requestToken)
http:setOAuthVerifier(authVerifier)
req:setHttpVerb("POST")
req:setContentType("application/x-www-form-urlencoded")
success = http:HttpReq(accessTokenUrl,req,resp)
if success == false then
print(http:LastErrorText())
end
-- Make sure a successful response was received.
if resp:StatusCode() ~= 200 then
print(resp:StatusLine())
print(resp:Header())
print(resp:BodyStr())
end
-- If successful, the resp.BodyStr contains something like this:
-- oauth_token=12347455-ffffrrlaBdCjbdGfyjZabcdb5APNtuTPNabcdEpp&oauth_token_secret=RxxxxJ8mTzUhwES4xxxxuJyFWDN8ZfHmrabcddh88LmWE
print(resp:BodyStr())
local hashTab2 = chilkat.newHashtable{}
hashTab2:AddQueryParams(resp:BodyStr())
local accessToken = hashTab2:LookupStr("oauth_token")
local accessTokenSecret = hashTab2:LookupStr("oauth_token_secret")
-- The access token + secret is what should be saved and used for
-- subsequent REST API calls.
print("Access Token = ", accessToken)
print("Access Token Secret = ", accessTokenSecret)
-- Save this access token for future calls.
local json = chilkat.newJsonObject{}
json:AppendString("oauth_token",accessToken)
json:AppendString("oauth_token_secret",accessTokenSecret)
-- Also save the realmId and dataSource from hashTab1.
local realmId = hashTab1:LookupStr("realmId")
print("realmId = ", realmId)
local dataSource = hashTab1:LookupStr("dataSource")
print("dataSource = ", dataSource)
json:AppendString("realmId",realmId)
json:AppendString("dataSource",dataSource)
local fac = chilkat.newFileAccess{}
fac:WriteEntireTextFile("qa_data/tokens/quickbooks.json",json:Emit(),"utf-8",false)
print("Success.")