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

Perl Web API Examples

Primary Categories

AWS Translate
Azure Maps
Azure OAuth2
Azure Storage Accounts
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans





(Perl) Xero OAuth1 Authorization (3-legged)

Demonstrates 3-legged OAuth1 authorization for Xero

Chilkat Perl Downloads

Perl Module for Windows, Linux, Alpine Linux,
MAC OS X, Solaris, FreeBSD, OpenBSD,
Raspberry Pi and other single board computers

use chilkat();

$consumerKey = "XERO_CONSUMER_KEY";
$consumerSecret = "XERO_CONSUMER_SECRET";

$requestTokenUrl = "";
$authorizeUrl = "";
$accessTokenUrl = "";

# The port number is picked at random. It's some unused port that won't likely conflict with anything else..
$callbackUrl = "http://localhost:3017/";
$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
$http = chilkat::CkHttp->new();


$req = chilkat::CkHttpRequest->new();
# resp is a HttpResponse
$resp = $http->PostUrlEncoded($requestTokenUrl,$req);
if ($http->get_LastMethodSuccess() != 1) {
    print $http->lastErrorText() . "\r\n";

# If successful, the resp.BodyStr contains something like this:  
# oauth_token=-Wa_KwAAAAAAxfEPAAABV8Qar4Q&oauth_token_secret=OfHY4tZBX2HK4f7yIw76WYdvnl99MVGB&oauth_callback_confirmed=true
print $resp->bodyStr() . "\r\n";

$hashTab = chilkat::CkHashtable->new();

$requestToken = $hashTab->lookupStr("oauth_token");
$requestTokenSecret = $hashTab->lookupStr("oauth_token_secret");

print "oauth_token = " . $requestToken . "\r\n";
print "oauth_token_secret = " . $requestTokenSecret . "\r\n";

# ---------------------------------------------------------------------------
# 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.
$sbUrlForBrowser = chilkat::CkStringBuilder->new();
$urlForBrowser = $sbUrlForBrowser->getAsString();

# When the urlForBrowser is loaded into a browser, the response from Xero 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.
$listenSock = chilkat::CkSocket->new();

$backLog = 5;
$success = $listenSock->BindAndListen($callbackLocalPort,$backLog);
if ($success != 1) {
    print $listenSock->lastErrorText() . "\r\n";

# 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.
$maxWaitMs = 60000;
# task is a Task
$task = $listenSock->AcceptNextConnectionAsync($maxWaitMs);

#  At this point, your application should load the URL in a browser.
#  For example,
#  in C#:  System.Diagnostics.Process.Start(urlForBrowser);
#  in Java: Desktop.getDesktop().browse(new URI(urlForBrowser));
#  in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
#               wsh.Run urlForBrowser
#  The Xero 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(urlForBrowser);

# Wait for the listenSock's task to complete.
$success = $task->Wait($maxWaitMs);
if (!$success or ($task->get_StatusInt() != 7) or ($task->get_TaskSuccess() != 1)) {
    if (!$success) {
        # The task.LastErrorText applies to the Wait method call.
        print $task->lastErrorText() . "\r\n";
    else {
        # The ResultErrorText applies to the underlying task method call (i.e. the AcceptNextConnection)
        print $task->status() . "\r\n";
        print $task->resultErrorText() . "\r\n";


# 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.

# First get the connected socket.
$sock = chilkat::CkSocket->new();

# Read the start line of the request..
$startLine = $sock->receiveUntilMatch("\r\n");
if ($sock->get_LastMethodSuccess() != 1) {
    print $sock->lastErrorText() . "\r\n";

# Read the request header.
$requestHeader = $sock->receiveUntilMatch("\r\n\r\n");
if ($sock->get_LastMethodSuccess() != 1) {
    print $sock->lastErrorText() . "\r\n";

# 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.
$sbResponseHtml = chilkat::CkStringBuilder->new();
$sbResponseHtml->Append("<html><body><p>Chilkat thanks you!</b></body</html>");

$sbResponse = chilkat::CkStringBuilder->new();
$sbResponse->Append("HTTP/1.1 200 OK\r\n");
$sbResponse->Append("Content-Length: ");
$sbResponse->Append("Content-Type: text/html\r\n");


# The information we need is in the startLine.
# For example, the startLine will look something like this:
#  GET /?oauth_token=abcdRQAAZZAAxfBBAAABVabcd_k&oauth_verifier=9rdOq5abcdCe6cn8M3jabcdj3Eabcd&org=mUkIZabcdKEababcd189t0 HTTP/1.1
$sbStartLine = chilkat::CkStringBuilder->new();
$numReplacements = $sbStartLine->Replace("GET /?","");
$numReplacements = $sbStartLine->Replace(" HTTP/1.1","");

# oauth_token=abcdRQAAZZAAxfBBAAABVabcd_k&oauth_verifier=9rdOq5abcdCe6cn8M3jabcdj3Eabcd&org=mUkIZabcdKEababcd189t0
print "startline: " . $sbStartLine->getAsString() . "\r\n";


$requestToken = $hashTab->lookupStr("oauth_token");
$authVerifier = $hashTab->lookupStr("oauth_verifier");

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

# resp is a HttpResponse
$resp = $http->PostUrlEncoded($accessTokenUrl,$req);
if ($http->get_LastMethodSuccess() != 1) {
    print $http->lastErrorText() . "\r\n";

# Make sure a successful response was received.
if ($resp->get_StatusCode() != 200) {
    print $resp->statusLine() . "\r\n";
    print $resp->header() . "\r\n";
    print $resp->bodyStr() . "\r\n";

# If successful, the resp.BodyStr contains something like this:
# oauth_token=85123455-fF41296Bi3daM8eCo9Y5vZabcdxXpRv864plYPOjr&oauth_token_secret=afiYJOgabcdSfGae7BDvJVVTwys8fUGpra5guZxbmFBZo&oauth_expires_in=1800&xero_org_muid=abcdecNhPKabcdNjz189t0
print $resp->bodyStr() . "\r\n";


$accessToken = $hashTab->lookupStr("oauth_token");
$accessTokenSecret = $hashTab->lookupStr("oauth_token_secret");
$orgMuid = $hashTab->lookupStr("xero_org_muid");
$expiresIn = $hashTab->lookupStr("oauth_expires_in");

# The access token + secret is what should be saved and used for
# subsequent REST API calls.
print "Access Token = " . $accessToken . "\r\n";
print "Access Token Secret = " . $accessTokenSecret . "\r\n";
print "xero_org_muid = " . $orgMuid . "\r\n";
print "oauth_expires_in  = " . $expiresIn . "\r\n";

# Save this access token for future calls.
# Just in case we need xero_org_muid and oauth_expires_in, save those also..
$json = chilkat::CkJsonObject->new();

$fac = chilkat::CkFileAccess->new();

print "Success." . "\r\n";


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