PHP Extension

GeoOp OAuth2 Authorisation Code Grant (Public App)

See more OAuth2 Examples

Demonstrates how to get an access token for a GeoOp Third-Party Public Application using the Authorisation Code Grant flow. PHP Extension

<?php

include("chilkat.php");

$success = false;

// It requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$oauth2 = new CkOAuth2();

// This should match the Site URL configured for your GeoOp (non-Server) Application, such as "http://localhost:3017/"
$oauth2->put_ListenPort(3017);

$oauth2->put_AuthorizationEndpoint('https://login.geoop.com/oauth2/code');
$oauth2->put_TokenEndpoint('https://login.geoop.com/oauth2/token');

// Replace the client ID with an actual value.
$oauth2->put_ClientId('GEOOP-APPLICATION-ID');
// The ClientSecret should remain empty for a GeoOp public application
$oauth2->put_ClientSecret('');

// We need a few special settings for GeoOp
$oauth2->put_Scope('default');
$oauth2->put_CodeChallenge(false);
// Setting LocalHost equal to "none" prevents the "redirect_uri" query param from being sent in the initial HTTP request.
// Note: The GeoOp Application should still have a redirect URL specified as "http://localhost:3017/", where the port
// number matches the ListenPort above.
$oauth2->put_LocalHost('none');

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

// 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 == false) {
    print $oauth2->lastErrorText() . "\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!' . "\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.' . "\n";
    print $oauth2->failureInfo() . "\n";
    exit;
}

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

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

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

// Save the entire JSON response, which includes the access token, for future calls.
// The JSON AccessTokenResponse looks like this:
// {"access_token":"e6dqdG....mzjpT04w==","token_type":"Bearer","expires_in":2592000,"owner_id":984236}

$fac = new CkFileAccess();
$fac->WriteEntireTextFile('qa_data/tokens/geoop.json',$oauth2->accessTokenResponse(),'utf-8',false);

print 'Success.' . "\n";

?>