(Xojo Plugin) Etsy OAuth1 Authorization

See more Etsy Examples

Demonstrates 3-legged OAuth1 authorization for Etsy.

For more information, see https://www.etsy.com/developers/documentation/getting_started/oauth

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

Dim consumerKey As String
consumerKey = "keystring"
Dim consumerSecret As String
consumerSecret = "shared_secret"

// Specify one or more SPACE separated scopes as query params in the requestTokenUrl
// See https://www.etsy.com/developers/documentation/getting_started/oauth#section_permission_scopes
Dim requestTokenUrl As String
requestTokenUrl = "https://openapi.etsy.com/v2/oauth/request_token?scope=email_r%20listings_r%20listings_w%20listings_d"
Dim authorizeUrl As String
authorizeUrl = "https://www.etsy.com/oauth/signin"
Dim accessTokenUrl As String
accessTokenUrl = "https://openapi.etsy.com/v2/oauth/access_token"

// The port number is picked at random. It's some unused port that won't likely conflict with anything else..
Dim callbackUrl As String
callbackUrl = "http://localhost:3017/"
Dim callbackLocalPort As Int32
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
Dim http As New Chilkat.Http
Dim success As Boolean

http.OAuth1 = True
http.OAuthConsumerKey = consumerKey
http.OAuthConsumerSecret = consumerSecret
http.OAuthCallback = callbackUrl

Dim req As New Chilkat.HttpRequest
Dim resp As Chilkat.HttpResponse
resp = http.PostUrlEncoded(requestTokenUrl,req)
If (http.LastMethodSuccess <> True) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

// If successful, the resp.BodyStr contains something like this:  
// login_url=https%3A%2F%2Fwww.etsy.com%2Foauth%2Fsignin%3Foauth_consumer_key%3D9ad9l1omxzbwfr2niq0ce1ly%26oauth_token%3D7116b4d0c72c2736561853d9e50113%26service%3Dv2_prod&oauth_token=7116b4d0c72c2736561853d9e50113&oauth_token_secret=3b7612b5d3&oauth_callback_confirmed=true&oauth_consumer_key=9ad9l1omxzbwfr2niq0ce1ly&oauth_callback=http%3A%2F%2Flocalhost%3A3017%2F
System.DebugLog(resp.BodyStr)

// We'll need this for later..
Dim hashTab As New Chilkat.Hashtable
success = hashTab.AddQueryParams(resp.BodyStr)

Dim requestToken As String
requestToken = hashTab.LookupStr("oauth_token")
Dim requestTokenSecret As String
requestTokenSecret = hashTab.LookupStr("oauth_token_secret")
http.OAuthTokenSecret = requestTokenSecret

System.DebugLog("oauth_token = " + requestToken)
System.DebugLog("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.
Dim sbUrlForBrowser As New Chilkat.StringBuilder
success = sbUrlForBrowser.Append(authorizeUrl)
success = sbUrlForBrowser.Append("?")
success = sbUrlForBrowser.Append(resp.BodyStr)
Dim url As String
url = sbUrlForBrowser.GetAsString()

// When the url is loaded into a browser, the response from Etsy 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.
Dim listenSock As New Chilkat.Socket

Dim backLog As Int32
backLog = 5
success = listenSock.BindAndListen(callbackLocalPort,backLog)
If (success <> True) Then
    System.DebugLog(listenSock.LastErrorText)
    Return
End If

// 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.
Dim maxWaitMs As Int32
maxWaitMs = 60000
Dim task As Chilkat.Task
task = listenSock.AcceptNextConnectionAsync(maxWaitMs)
success = task.Run()

// ****************************************************************
// At this point, your application should load the URL in a browser.
// For example, 
// in C#: System.Diagnostics.Process.Start(url);
// in Java: Desktop.getDesktop().browse(new URI(url));
// in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
//              wsh.Run url
// in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
// in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
// The Google 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(url);
// ****************************************************************

// Wait for the listenSock's task to complete.
success = task.Wait(maxWaitMs)
If (Not success Or (task.StatusInt <> 7) Or (task.TaskSuccess <> True)) Then
    If (Not success) Then
        // The task.LastErrorText applies to the Wait method call.
        System.DebugLog(task.LastErrorText)
    Else
        // The ResultErrorText applies to the underlying task method call (i.e. the AcceptNextConnection)
        System.DebugLog(task.Status)
        System.DebugLog(task.ResultErrorText)
    End If

    Return
End If

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

// We no longer need the listen socket...
// Stop listening on port 3017.
success = listenSock.Close(10)

// First get the connected socket.
Dim sock As New Chilkat.Socket
success = sock.LoadTaskResult(task)

// Read the start line of the request..
Dim startLine As String
startLine = sock.ReceiveUntilMatch(EndOfLine.Windows)
If (sock.LastMethodSuccess <> True) Then
    System.DebugLog(sock.LastErrorText)
    Return
End If

// Read the request header.
Dim requestHeader As String
requestHeader = sock.ReceiveUntilMatch(EndOfLine.Windows + EndOfLine.Windows)
If (sock.LastMethodSuccess <> True) Then
    System.DebugLog(sock.LastErrorText)
    Return
End If

// 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.
Dim sbResponseHtml As New Chilkat.StringBuilder
success = sbResponseHtml.Append("<html><body><p>Chilkat thanks you!</b></body</html>")

Dim sbResponse As New Chilkat.StringBuilder
success = sbResponse.Append("HTTP/1.1 200 OK" + EndOfLine.Windows)
success = sbResponse.Append("Content-Length: ")
success = sbResponse.AppendInt(sbResponseHtml.Length)
success = sbResponse.Append(EndOfLine.Windows)
success = sbResponse.Append("Content-Type: text/html" + EndOfLine.Windows)
success = sbResponse.Append(EndOfLine.Windows)
success = sbResponse.AppendSb(sbResponseHtml)

success = sock.SendString(sbResponse.GetAsString())
success = sock.Close(50)

// The information we need is in the startLine.
// For example, the startLine will look like this:
//  GET /?oauth_token=a3bc8bec84acc31418b68a532e9511&oauth_verifier=b5558d37 HTTP/1.1
Dim sbStartLine As New Chilkat.StringBuilder
success = sbStartLine.Append(startLine)
Dim numReplacements As Int32
numReplacements = sbStartLine.Replace("GET /?","")
numReplacements = sbStartLine.Replace(" HTTP/1.1","")
success = sbStartLine.Trim()

// oauth_token=a3bc8bec84acc31418b68a532e9511&oauth_verifier=b5558d37
System.DebugLog("startline: " + sbStartLine.GetAsString())

hashTab.Clear 
success = hashTab.AddQueryParams(sbStartLine.GetAsString())

requestToken = hashTab.LookupStr("oauth_token")
Dim authVerifier As String
authVerifier = hashTab.LookupStr("oauth_verifier")

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

http.OAuthToken = requestToken
http.OAuthVerifier = authVerifier
resp = http.PostUrlEncoded(accessTokenUrl,req)
If (http.LastMethodSuccess <> True) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

// Make sure a successful response was received.
If (resp.StatusCode <> 200) Then
    System.DebugLog(resp.StatusLine)
    System.DebugLog(resp.Header)
    System.DebugLog(resp.BodyStr)
    Return
End If

// If successful, the resp.BodyStr contains something like this:
// oauth_token=7898d7ba280dc791586dcfd26b37a9&oauth_token_secret=f2a7c267aa
System.DebugLog(resp.BodyStr)

hashTab.Clear 
success = hashTab.AddQueryParams(resp.BodyStr)

Dim accessToken As String
accessToken = hashTab.LookupStr("oauth_token")
Dim accessTokenSecret As String
accessTokenSecret = hashTab.LookupStr("oauth_token_secret")

// The access token + secret is what should be saved and used for
// subsequent REST API calls.
System.DebugLog("Access Token = " + accessToken)
System.DebugLog("Access Token Secret = " + accessTokenSecret)

// Save this access token for future calls.
// Just in case we need user_id and screen_name, save those also..
Dim json As New Chilkat.JsonObject
success = json.AppendString("oauth_token",accessToken)
success = json.AppendString("oauth_token_secret",accessTokenSecret)

Dim fac As New Chilkat.FileAccess
success = fac.WriteEntireTextFile("qa_data/tokens/etsy.json",json.Emit(),"utf-8",False)

System.DebugLog("Success.")