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

Xojo Plugin 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

 

 

 

(Xojo Plugin) Xero API through an SOCKS Proxy

This example demonstrates connecting through a SOCKS proxy w/ 2-legged OAuth for a Xero private application.

This example requires Chilkat v9.5.0.64 or later

Chilkat Xojo Plugin Download

Xojo Plugin for Windows, Linux, Mac OS X, and ARM

// This example requires Chilkat v9.5.0.64 or later

// 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.
Dim rest As New Chilkat.Rest

// Connect to the Xero server through an HTTP proxy, and then tell the REST object
// to use the socket connection.
Dim socket As New Chilkat.Socket

// Set the SOCKS proxy domain or IP address, port, and SOCKS version number (4 or 5)
socket.SocksHostname = "192.168.1.100"
socket.SocksPort = 1080
socket.SocksVersion = 5
// Other properties exist for specifying a SOCKS proxy login and password,
// but these are not used in this example.

// Connect through the SOCKS proxy..
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim maxWaitMs As Int32
maxWaitMs = 5000
Dim success As Boolean
success = socket.Connect("api.xero.com",port,bTls,maxWaitMs)
If (success <> True) Then
    System.DebugLog("Connect Failure Error Code: " + Str(socket.ConnectFailReason))
    System.DebugLog(socket.LastErrorText)
    Return
End If

// Use the SOCKS proxied TLS connection:
success = rest.UseConnection(socket,True)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// OK, we're connected.  
// The UseConnection method has an internal reference to the underlying/internal socket.
// The application can does not need to keep its socket object in existence.
// -----------------------------------------------------------------
// Now setup the OAuth1 authenticator..

Dim consumerKey As String
consumerKey = "XERO_PRIVATE_APP_KEY"
Dim consumerSecret As String
consumerSecret = "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.
Dim pfx As New Chilkat.Pfx
success = pfx.LoadPfxFile("qa_data/certs/xero_private_app/public_privatekey.pfx","PFX_PASSWORD")
If (success <> True) Then
    System.DebugLog(pfx.LastErrorText)
    Return
End If

Dim privKeyFromPfx As Chilkat.PrivateKey
privKeyFromPfx = pfx.GetPrivateKey(0)
If (pfx.LastMethodSuccess <> True) Then
    System.DebugLog(pfx.LastErrorText)
    Return
End If

// Or we can load from a PEM..
Dim privKeyFromPem As New Chilkat.PrivateKey
success = privKeyFromPem.LoadPemFile("qa_data/certs/xero_private_app/privatekey.pem")
If (success <> True) Then
    System.DebugLog(privKeyFromPem.LastErrorText)
    Return
End If

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

Dim oauth1 As New Chilkat.OAuth1
oauth1.ConsumerKey = consumerKey
oauth1.ConsumerSecret = consumerSecret
oauth1.Token = consumerKey
oauth1.TokenSecret = consumerSecret
oauth1.SignatureMethod = "RSA-SHA1"
success = oauth1.SetRsaKey(privKeyFromPfx)

// Install the OAuth1 authenticator.
success = rest.SetAuthOAuth1(oauth1,False)

System.DebugLog("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.
Dim sbXml As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET","/api.xro/2.0/Contacts",sbXml)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// A 200 response is expected for actual success.
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog(sbXml.GetAsString())
    Return
End If

// Iterate over the contacts..
Dim bAutoTrim As Boolean
bAutoTrim = False
Dim xml As New Chilkat.Xml
success = xml.LoadSb(sbXml,bAutoTrim)
success = xml.SaveXml("qa_cache/xero_contacts.xml")

// How many records exist?
Dim recordCount As Int32
recordCount = xml.NumChildrenAt("Contacts")
System.DebugLog("numRecords = " + Str(recordCount))

Dim i As Int32
i = 0
While i < recordCount
    xml.I = i
    System.DebugLog("ContactID: " + xml.GetChildContent("Contacts|Contact[i]|ContactID"))
    i = i + 1
Wend

 

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