(Node.js) GeoOp OAuth2 Authorisation Code Grant (Public App)

See more OAuth2 Examples

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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOS

var os = require('os');
if (os.platform() == 'win32') {  
  var chilkat = require('@chilkat/ck-node23-win64'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node23-linux-arm');
    } else if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node23-linux-arm64');
    } else {
        var chilkat = require('@chilkat/ck-node23-linux-x64');
    }
} else if (os.platform() == 'darwin') {
  var chilkat = require('@chilkat/ck-node23-mac-universal');
}

function chilkatExample() {

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

    var oauth2 = new chilkat.OAuth2();

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

    oauth2.AuthorizationEndpoint = "https://login.geoop.com/oauth2/code";
    oauth2.TokenEndpoint = "https://login.geoop.com/oauth2/token";

    // Replace the client ID with an actual value.
    oauth2.ClientId = "GEOOP-APPLICATION-ID";
    // The ClientSecret should remain empty for a GeoOp public application
    oauth2.ClientSecret = "";

    // We need a few special settings for GeoOp
    oauth2.Scope = "default";
    oauth2.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.LocalHost = "none";

    // Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    var url = oauth2.StartAuth();
    if (oauth2.LastMethodSuccess !== true) {
        console.log(oauth2.LastErrorText);
        return;
    }

    // Launch the default browser on the system and navigate to the url.
    // The LaunchBrowser method was added in Chilkat v10.1.2.
    var success = oauth2.LaunchBrowser(url);
    if (success == false) {
        console.log(oauth2.LastErrorText);
        return;
    }

    // Wait for the user to approve or deny authorization in the browser.
    var numMsWaited = 0;
    while ((numMsWaited < 90000) && (oauth2.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.AuthFlowState < 3) {
        oauth2.Cancel();
        console.log("No response from the browser!");
        return;
    }

    // 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.AuthFlowState == 5) {
        console.log("OAuth2 failed to complete.");
        console.log(oauth2.FailureInfo);
        return;
    }

    if (oauth2.AuthFlowState == 4) {
        console.log("OAuth2 authorization was denied.");
        console.log(oauth2.AccessTokenResponse);
        return;
    }

    if (oauth2.AuthFlowState !== 3) {
        console.log("Unexpected AuthFlowState:" + oauth2.AuthFlowState);
        return;
    }

    console.log("OAuth2 authorization granted!");
    console.log("Access Token = " + oauth2.AccessToken);

    // 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}

    var fac = new chilkat.FileAccess();
    fac.WriteEntireTextFile("qa_data/tokens/geoop.json",oauth2.AccessTokenResponse,"utf-8",false);

    console.log("Success.");

}

chilkatExample();