(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    var consumerKey: String? = "keystring"
    var consumerSecret: String? = "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
    var requestTokenUrl: String? = "https://openapi.etsy.com/v2/oauth/request_token?scope=email_r%20listings_r%20listings_w%20listings_d"
    var authorizeUrl: String? = "https://www.etsy.com/oauth/signin"
    var accessTokenUrl: String? = "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..
    var callbackUrl: String? = "http://localhost:3017/"
    var callbackLocalPort: Int = 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
    let http = CkoHttp()!
    var success: Bool

    http.oAuth1 = true
    http.oAuthConsumerKey = consumerKey
    http.oAuthConsumerSecret = consumerSecret
    http.oAuthCallback = callbackUrl

    let req = CkoHttpRequest()!
    var resp: CkoHttpResponse? = http.postUrlEncoded(requestTokenUrl, req: req)
    if http.lastMethodSuccess != true {
        print("\(http.lastErrorText!)")
        return
    }

    // 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
    print("\(resp!.bodyStr!)")

    // We'll need this for later..
    let hashTab = CkoHashtable()!
    hashTab.addQueryParams(resp!.bodyStr)

    var requestToken: String? = hashTab.lookupStr("oauth_token")
    var requestTokenSecret: String? = hashTab.lookupStr("oauth_token_secret")
    http.oAuthTokenSecret = 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.
    let sbUrlForBrowser = CkoStringBuilder()!
    sbUrlForBrowser.append(authorizeUrl)
    sbUrlForBrowser.append("?")
    sbUrlForBrowser.append(resp!.bodyStr)
    var url: String? = sbUrlForBrowser.getAsString()

    resp = nil

    // 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.
    let listenSock = CkoSocket()!

    var backLog: Int = 5
    success = listenSock.bindAndListen(callbackLocalPort, backlog: backLog)
    if success != true {
        print("\(listenSock.lastErrorText!)")
        return
    }

    // 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.
    var maxWaitMs: Int = 60000
    var task: CkoTask? = listenSock.acceptNextConnectionAsync(maxWaitMs)
    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 !success || (task!.statusInt.intValue != 7) || (task!.taskSuccess != true) {
        if !success {
            // 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!)")
        }

        task = nil
        return
    }

    // 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.
    listenSock.close(10)

    // First get the connected socket.
    let sock = CkoSocket()!
    sock.loadTaskResult(task)
    task = nil

    // Read the start line of the request..
    var startLine: String? = sock.receive(untilMatch: "\r\n")
    if sock.lastMethodSuccess != true {
        print("\(sock.lastErrorText!)")
        return
    }

    // Read the request header.
    var requestHeader: String? = sock.receive(untilMatch: "\r\n\r\n")
    if sock.lastMethodSuccess != true {
        print("\(sock.lastErrorText!)")
        return
    }

    // 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.
    let sbResponseHtml = CkoStringBuilder()!
    sbResponseHtml.append("<html><body><p>Chilkat thanks you!</b></body</html>")

    let sbResponse = CkoStringBuilder()!
    sbResponse.append("HTTP/1.1 200 OK\r\n")
    sbResponse.append("Content-Length: ")
    sbResponse.appendInt(sbResponseHtml.length.intValue)
    sbResponse.append("\r\n")
    sbResponse.append("Content-Type: text/html\r\n")
    sbResponse.append("\r\n")
    sbResponse.appendSb(sbResponseHtml)

    sock.send(sbResponse.getAsString())
    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
    let sbStartLine = CkoStringBuilder()!
    sbStartLine.append(startLine)
    var numReplacements: Int = sbStartLine.replace("GET /?", replacement: "").intValue
    numReplacements = sbStartLine.replace(" HTTP/1.1", replacement: "").intValue
    sbStartLine.trim()

    // oauth_token=a3bc8bec84acc31418b68a532e9511&oauth_verifier=b5558d37
    print("startline: \(sbStartLine.getAsString()!)")

    hashTab.clear()
    hashTab.addQueryParams(sbStartLine.getAsString())

    requestToken = hashTab.lookupStr("oauth_token")
    var authVerifier: String? = 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: req)
    if http.lastMethodSuccess != true {
        print("\(http.lastErrorText!)")
        return
    }

    // Make sure a successful response was received.
    if resp!.statusCode.intValue != 200 {
        print("\(resp!.statusLine!)")
        print("\(resp!.header!)")
        print("\(resp!.bodyStr!)")
        return
    }

    // If successful, the resp.BodyStr contains something like this:
    // oauth_token=7898d7ba280dc791586dcfd26b37a9&oauth_token_secret=f2a7c267aa
    print("\(resp!.bodyStr!)")

    hashTab.clear()
    hashTab.addQueryParams(resp!.bodyStr)

    var accessToken: String? = hashTab.lookupStr("oauth_token")
    var accessTokenSecret: String? = hashTab.lookupStr("oauth_token_secret")

    resp = nil

    // 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.
    // Just in case we need user_id and screen_name, save those also..
    let json = CkoJsonObject()!
    json.append("oauth_token", value: accessToken)
    json.append("oauth_token_secret", value: accessTokenSecret)

    let fac = CkoFileAccess()!
    fac.writeEntireTextFile("qa_data/tokens/etsy.json", fileData: json.emit(), charset: "utf-8", includePreamble: false)

    print("Success.")

}