(Perl) WiX OAuth2 Access Token

Demonstrates how to get an access token for the WiX API. This example is for desktop apps only (not web apps).

Note: This example requires Chilkat v9.5.0.84 or greater.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# IMPORTANT: This example requires Chilkat v9.5.0.84 or greater because WiX does OAuth2 in a non-standard way.
# Internal modifications were made in Chilkat v9.5.0.84 to automatically accomodate the non-standard WiX implementation.

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

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

# See https://dev.wix.com/api/rest/getting-started/authentication
$oauth2->put_AuthorizationEndpoint("https://www.wix.com/app-oauth-installation/consent");
$oauth2->put_TokenEndpoint("https://www.wix.com/oauth/access");

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

# WiX is different than most other OAuth2 authorizations when it comes to scope.
# The scopes are assigned to your defined application in the "Permissions" part of the developers console (https://dev.wix.com/....)
# where you define your App (i.e. where the App ID, App Secret Key, Redirect URL, etc. are defined).
$oauth2->put_Scope("");

# Begin the OAuth2 three-legged 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;
}

# At this point, your application should load the URL in a browser.
# For example, 
# in C#: System.Diagnostics.Process.Start(url);
# in Java: Desktop.getDesktop().browse(new URI(url));
# in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
#              wsh.Run url
# in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
# in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
# The Microsoft 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...

# Now wait for the authorization.
# We'll wait for a max of 30 seconds.
$numMsWaited = 0;
while (($numMsWaited < 30000) and ($oauth2->get_AuthFlowState() < 3)) {
    $oauth2->SleepMs(100);
    $numMsWaited = $numMsWaited + 100;
}

# If there was no response from the browser within 30 seconds, then 
# the AuthFlowState will be equal to 1 or 2.
# 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
# 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
# In that case, cancel the background task started in the call to StartAuth.
if ($oauth2->get_AuthFlowState() < 3) {
    $oauth2->Cancel();
    print "No response from the browser!" . "\r\n";
    exit;
}

# Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
# The possible AuthFlowState values are:
# 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
# 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
# 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
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:

# {
#   "refresh_token": "OAUTH2.eyJraW ... vnB4cQ",
#   "access_token": "OAUTH2.eyJraW ... 18lrw"
# }

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

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