Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Excel Web API Examples

Primary Categories

ABN AMRO
AWS Secrets Manager
AWS Translate
Activix CRM
Adyen
Alibaba Cloud OSS
Amazon Cognito
Amazon DynamoDB
Amazon MWS
Amazon Pay
Amazon Rekognition
Amazon Voice ID
Aruba Fatturazione
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Backblaze S3
Bitfinex v2 REST
Bluzone
BrickLink
CallRail
CardConnect
Cerved
ClickBank
Clickatell
Cloudfare
Constant Contact
DocuSign
Duo Auth MFA
ETrade
Ecwid
Egypt ITIDA
Etsy
Facebook
Faire
Frame.io
GeoOp
GetHarvest
Global Payments
Google People
Google Search Console
Hungary NAV Invoicing
IBM Text to Speech
Ibanity
IntakeQ
Jira
Lightspeed
MYOB
Magento
Mailgun
Mastercard

MedTunnel
MercadoLibre
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Microsoft Teams
Moody's
Okta OAuth/OIDC
OneLogin OIDC
OneNote
PRODA
PayPal
Paynow.pl
Peoplevox
Populi
QuickBooks
Rabobank
Refinitiv
Royal Mail OBA
SCiS Schools Catalogue
SII Chile
SMSAPI
SOAP finkok.com
SendGrid
Shippo
Shopify
Shopware
Shopware 6
SimpleTexting
Square
Stripe
SugarCRM
TicketBAI
Trello
Twilio
Twitter
UniPin
VoiceBase
Vonage
Walmart
Walmart v3
Wasabi
WhatsApp
WiX
WooCommerce
WordPress
Xero
Yahoo Mail
Yousign
Zoom
_Miscellaneous_
eBay
effectconnect
hacienda.go.cr

 

 

 

(Excel) Xero API through an HTTP Proxy

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

This example requires Chilkat v9.5.0.64 or later

Download Excel Class Modules

Chilkat Excel Class Modules

' 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 Chilkat.Rest
Set rest = Chilkat.NewRest

' Connect to the Xero server through an HTTP proxy, and then tell the REST object
' to use the socket connection.
Dim socket As Chilkat.Socket
Set socket = Chilkat.NewSocket

' Set the HTTP proxy domain or IP address, and port.
socket.HttpProxyHostname = "192.168.1.100"
socket.HttpProxyPort = 8088

' Connect through the HTTP proxy..

bTls = True

port = 443

maxWaitMs = 5000

success = socket.Connect("api.xero.com",port,bTls,maxWaitMs)
If (success <> True) Then
    Debug.Print "Connect Failure Error Code: "; socket.ConnectFailReason
    Debug.Print socket.LastErrorText
    Exit Sub
End If

' Use the HTTP proxied TLS connection:
success = rest.UseConnection(socket,True)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
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..


consumerKey = "XERO_PRIVATE_APP_KEY"

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 Chilkat.Pfx
Set pfx = Chilkat.NewPfx
success = pfx.LoadPfxFile("qa_data/certs/xero_private_app/public_privatekey.pfx","PFX_PASSWORD")
If (success <> True) Then
    Debug.Print pfx.LastErrorText
    Exit Sub
End If


Set privKeyFromPfx = pfx.GetPrivateKey(0)
If (pfx.LastMethodSuccess <> True) Then
    Debug.Print pfx.LastErrorText
    Exit Sub
End If

' Or we can load from a PEM..
Dim privKeyFromPem As Chilkat.PrivateKey
Set privKeyFromPem = Chilkat.NewPrivateKey
success = privKeyFromPem.LoadPemFile("qa_data/certs/xero_private_app/privatekey.pem")
If (success <> True) Then
    Debug.Print privKeyFromPem.LastErrorText
    Exit Sub
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 Chilkat.OAuth1
Set oauth1 = Chilkat.NewOAuth1
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)

Debug.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.
Dim sbXml As Chilkat.StringBuilder
Set sbXml = Chilkat.NewStringBuilder
success = rest.FullRequestNoBodySb("GET","/api.xro/2.0/Contacts",sbXml)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' A 200 response is expected for actual success.
If (rest.ResponseStatusCode <> 200) Then
    Debug.Print sbXml.GetAsString()
    Exit Sub
End If

' Iterate over the contacts..

bAutoTrim = False
Dim xml As Chilkat.Xml
Set xml = Chilkat.NewXml
success = xml.LoadSb(sbXml,bAutoTrim)
success = xml.SaveXml("qa_cache/xero_contacts.xml")

' How many records exist?

recordCount = xml.NumChildrenAt("Contacts")
Debug.Print "numRecords = "; recordCount


i = 0
Do While i < recordCount
    xml.I = i
    Debug.Print "ContactID: "; xml.GetChildContent("Contacts|Contact[i]|ContactID")
    i = i + 1
Loop

 

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