Perl

Twinfield OAuth2 for Desktop App or Script

See more OAuth2 Examples

Demonstrates how to get a Twinfield OAuth2 access token from a desktop application or script. Perl

use chilkat();

$success = 0;

# For more information about the OAuth2, see OAuth 2.0 Authorization Flow

$oauth2 = chilkat::CkOAuth2->new();

# This should be the port in the localhost callback URL for your app.  
# The callback URL would look like "http://localhost:3017/" if the port number is 3017.
$oauth2->put_ListenPort(3017);

$oauth2->put_AuthorizationEndpoint("https://login.twinfield.com/auth/authentication/connect/authorize");
$oauth2->put_TokenEndpoint("https://login.twinfield.com/auth/authentication/connect/token");

# Replace these with actual values.
$oauth2->put_ClientId("CLIENT_ID");
$oauth2->put_ClientSecret("CLIENT_SECRET");

$oauth2->put_Scope("openid twf.user twf.organisation twf.organisationUser offline_access");

$oauth2->put_CodeChallenge(1);
$oauth2->put_CodeChallengeMethod("S256");

# Twinfield requires that the request to exchange the authorization code for a token must be a GET.
# (In most cases, OAuth2 is implemented where the exchange for token HTTP request is a POST.)
# Note: The exchange-for-token happens within Chilkat in a background thread.  After the user interactively 
# accepts or denies authorization, the browser receives the response and redirects to localhost:<port>,
# where Chilkat is waiting on a background thread to receive the redirect, process it, and then send the HTTP request
# to exchange the code for a token.  This happens internally while your code below is waiting for the authorization..)
$oauth2->put_UncommonOptions("EXCHANGE_CODE_FOR_TOKEN_USING_GET");

# Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
$url = $oauth2->startAuth();
if ($oauth2->get_LastMethodSuccess() != 1) {
    print $oauth2->lastErrorText() . "\r\n";
    exit;
}

print "url = " . $url . "\r\n";

# Launch the default browser on the system and navigate to the url.
# The LaunchBrowser method was added in Chilkat v10.1.2.
$success = $oauth2->LaunchBrowser($url);
if ($success == 0) {
    print $oauth2->lastErrorText() . "\r\n";
    exit;
}

# Wait for the user to approve or deny authorization in the browser.
$numMsWaited = 0;
while (($numMsWaited < 90000) and ($oauth2->get_AuthFlowState() < 3)) {
    $oauth2->SleepMs(100);
    $numMsWaited = $numMsWaited + 100;
}

# If the browser does not respond within the specified time, AuthFlowState will be:
# 
# 1: Waiting for Redirect - The OAuth2 background thread is waiting for the browser's redirect request.
# 2: Waiting for Final Response - The thread is awaiting the final access token response.
# In either case, cancel the background task initiated by StartAuth.

if ($oauth2->get_AuthFlowState() < 3) {
    $oauth2->Cancel();
    print "No response from the browser!" . "\r\n";
    exit;
}

# Check AuthFlowState to determine if authorization was granted, denied, or failed:
# 
# 3: Success - OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
# 4: Access Denied - OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
# 5: Failure - OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

if ($oauth2->get_AuthFlowState() == 5) {
    print "OAuth2 failed to complete." . "\r\n";
    print $oauth2->failureInfo() . "\r\n";
    exit;
}

if ($oauth2->get_AuthFlowState() == 4) {
    print "OAuth2 authorization was denied." . "\r\n";
    print $oauth2->accessTokenResponse() . "\r\n";
    exit;
}

if ($oauth2->get_AuthFlowState() != 3) {
    print "Unexpected AuthFlowState:" . $oauth2->get_AuthFlowState() . "\r\n";
    exit;
}

print "OAuth2 authorization granted!" . "\r\n";
print "Access Token = " . $oauth2->accessToken() . "\r\n";

# Get the full JSON response:
$json = chilkat::CkJsonObject->new();
$json->Load($oauth2->accessTokenResponse());
$json->put_EmitCompact(0);

# The JSON response looks like this:

print $json->emit() . "\r\n";

# Save the JSON to a file for future requests.
$fac = chilkat::CkFileAccess->new();
$fac->WriteEntireTextFile("qa_data/tokens/twinfield.json",$json->emit(),"utf-8",0);