(Perl) Rabobank OAuth2 Access Token

Demonstrates how to get an OAuth 2.0 access token to access Rabobank API's

Important: This example is for desktop apps only. (It is not for web-based applications.)

Your app defined in the Rabobank portal should look something like this. (Our test app is named "chilkat". You should name your app something else.)

Note: This example requires Chilkat v10.1.2 or greater.

For more information, see https://developer-sandbox.rabobank.nl/implementoauth2

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

use chilkat();

# 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);

# IMPORTANT: Don't forget to subscribe your Rabobank application to the OAuth 2.0 services in the Rabobank Online Developer Portal.
# IMPORTANT: Don't forget to subscribe your Rabobank application to the OAuth 2.0 services in the Rabobank Online Developer Portal.
# IMPORTANT: Don't forget to subscribe your Rabobank application to the OAuth 2.0 services in the Rabobank Online Developer Portal.
# IMPORTANT: Don't forget to subscribe your Rabobank application to the OAuth 2.0 services in the Rabobank Online Developer Portal.

# See also https://developer.rabobank.nl/faq

$oauth2->put_AuthorizationEndpoint("https://api-sandbox.rabobank.nl/openapi/sandbox/oauth2/authorize");
$oauth2->put_TokenEndpoint("https://api-sandbox.rabobank.nl/openapi/sandbox/oauth2/token");

# Replace these with actual values.
$oauth2->put_ClientId("YOUR_APP_CLIENT_ID");
# This is your app password:
$oauth2->put_ClientSecret("YOUR_APP_CLIENT_SECRET");

$oauth2->put_CodeChallenge(0);
# Provide a SPACE separated list of scopes, as defined in the Rabobank API documentation, 
# such as at https://developer-sandbox.rabobank.nl/reference/accounts-ais-sb/3-0-8

# Important: To get a refresh token in the final response, you have to ask for "offline_access" scope
$oauth2->put_Scope("ais.balances.read ais.transactions.read-90days ais.transactions.read-history");

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

# {
#   "token_type": "Bearer",
#   "access_token": "AAIkYTU0ZWM ... sxE0KL0HHWw",
#   "expires_in": 3600,
#   "consented_on": 1584641121,
#   "scope": "ais.balances.read ais.transactions.read-90days ais.transactions.read-history",
#   "refresh_token": "AAJXXSdN ... Uiblz9ILkxNBlytRGA",
#   "refresh_token_expires_in": 157784760,
#   "expires_on": "1584644722"
# }

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

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