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

Swift 3/4 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

 

 

 

(Swift 3/4) Xero API through an SSH Tunnel

This example demonstrates connecting through an SSH Tunnel w/ 2-legged OAuth for a Xero private application.

This example requires Chilkat v9.5.0.64 or later

Chilkat Downloads for the Swift Programming Language

MAC OS X (Cocoa) Objective-C/Swift Libs

iOS Objective-C/Swift Libs

func chilkatTest() {
    // This example requires Chilkat v9.5.0.64 or later

    let tunnel = CkoSocket()!

    var sshHostname: String? = "www.my-ssh-server.com"
    var sshPort: Int = 22

    // Connect to an SSH server and establish the SSH tunnel:
    var success: Bool = tunnel.sshOpenTunnel(sshHostname, sshPort: sshPort)
    if success != true {
        print("\(tunnel.lastErrorText!)")
        return
    }

    // Authenticate with the SSH server via a login/password
    // or with a public key.
    // This example demonstrates SSH password authentication.
    success = tunnel.sshAuthenticatePw("mySshLogin", sshPassword: "mySshPassword")
    if success != true {
        print("\(tunnel.lastErrorText!)")
        return
    }

    //  OK, the SSH tunnel is setup.  Now open a channel within the tunnel.
    //  (Any number of channels may be created from the same SSH tunnel.
    //  Multiple channels may coexist at the same time.)

    // This sample code would typically be placed in a subroutine or function
    // where the rest object is passed by reference.
    // It does the OAuth1 setup and makes the initial connection.
    let rest = CkoRest()!
    var channel: CkoSocket?

    var bTls: Bool = true
    var port: Int = 443
    var maxWaitMs: Int = 7000

    // This returns a socket object that is a single channel within the SSH tunnel.
    channel = tunnel.sshOpenChannel("api.xero.com", port: port, ssl: bTls, maxWaitMs: maxWaitMs)
    if tunnel.lastMethodSuccess != true {
        print("\(tunnel.lastErrorText!)")
        return
    }

    // Use the connection.  (This connection is a TLS running on an SSH channel through an SSH tunnel.
    // In other words, TLS is wrapped within the SSH tunnel.)
    success = rest.useConnection(channel, autoReconnect: true)
    if success != true {
        print("\(rest.lastErrorText!)")
        channel = nil
        return
    }

    // OK, we're connected.  
    // -----------------------------------------------------------------
    // Now setup the OAuth1 authenticator..

    var consumerKey: String? = "XERO_PRIVATE_APP_KEY"
    var consumerSecret: String? = "XERO_PRIVATE_APP_SECRET"

    // Let's get our private key from our PFX (password protected), or the PEM (unprotected).
    // You can decide which to use.  Either is OK, although I would recommend keeping your
    // private keys in a PFX and not in an unprotected PEM.
    let pfx = CkoPfx()!
    success = pfx.loadFile("qa_data/certs/xero_private_app/public_privatekey.pfx", password: "PFX_PASSWORD")
    if success != true {
        print("\(pfx.lastErrorText!)")
        return
    }

    var privKeyFromPfx: CkoPrivateKey? = pfx.getPrivateKey(0)
    if pfx.lastMethodSuccess != true {
        print("\(pfx.lastErrorText!)")
        return
    }

    // Or we can load from a PEM..
    let privKeyFromPem = CkoPrivateKey()!
    success = privKeyFromPem.loadPemFile("qa_data/certs/xero_private_app/privatekey.pem")
    if success != true {
        print("\(privKeyFromPem.lastErrorText!)")
        return
    }

    // Note: There are many other means for loading a private key, including
    // from other formats and directly from memory (i.e. not file-based).

    let oauth1 = CkoOAuth1()!
    oauth1.consumerKey = consumerKey
    oauth1.consumerSecret = consumerSecret
    oauth1.token = consumerKey
    oauth1.tokenSecret = consumerSecret
    oauth1.signatureMethod = "RSA-SHA1"
    oauth1.setRsaKey(privKeyFromPfx)
    privKeyFromPfx = nil

    // Install the OAuth1 authenticator.
    rest.setAuthOAuth1(oauth1, useQueryParams: false)

    print("OK, the Xero OAuth1 is initialized and the REST object is ready to make REST API calls..")

    // -----------------------------------------------------------------
    // Make a call to verify that OAuth1 through an HTTP proxy works..

    // Get the full list of contacts.
    let sbXml = CkoStringBuilder()!
    success = rest.fullRequestNoBodySb("GET", uriPath: "/api.xro/2.0/Contacts", sb: sbXml)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // A 200 response is expected for actual success.
    if rest.responseStatusCode.intValue != 200 {
        print("\(sbXml.getAsString()!)")
        return
    }

    // Iterate over the contacts..
    var bAutoTrim: Bool = false
    let xml = CkoXml()!
    xml.loadSb(sbXml, autoTrim: bAutoTrim)
    xml.save("qa_cache/xero_contacts.xml")

    // How many records exist?
    var recordCount: Int = xml.numChildren(at: "Contacts").intValue
    print("numRecords = \(recordCount)")

    var i: Int = 0
    while i < recordCount {
        xml.i = i
        print("ContactID: \(xml.getChildContent("Contacts|Contact[i]|ContactID")!)")
        i = i + 1
    }


}

 

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