(Node.js) Ecwid Get OAuth2 Access Token

See more Ecwid Examples

Demonstrates how to get an OAuth2 access token for an Ecwid application.

IMPORTANT: This example is for desktop apps. Web applications should follow representative examples at ASP.NET Samples for Obtaining OAuth2 Access Tokens or at Classic ASP Samples for Obtaining OAuth2 Access Tokens

Please read about Ecwid Authentication Basics prior to attempting this example.

For more information, see https://api-docs.ecwid.com/reference/get-access-token#get-token-manually

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

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var oauth2 = new chilkat.OAuth2();
    var success;

    // 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.ListenPort = 3017;

    oauth2.AuthorizationEndpoint = "https://my.ecwid.com/api/oauth/authorize";
    oauth2.TokenEndpoint = "https://my.ecwid.com/api/oauth/token";

    // Replace these with actual values.
    oauth2.ClientId = "CLIENT_ID";
    oauth2.ClientSecret = "CLIENT_SECRET";

    // See Ecwid scopes
    oauth2.Scope = "public_storefront update_catalog read_catalog create_catalog update_orders read_store_profile read_orders";

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

    // 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.
    var numMsWaited = 0;
    while ((numMsWaited < 30000) && (oauth2.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.AuthFlowState < 3) {
        oauth2.Cancel();
        console.log("No response from the browser!");
        return;
    }

    // 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.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);

    // Get the full JSON response:
    var json = new chilkat.JsonObject();
    json.Load(oauth2.AccessTokenResponse);
    json.EmitCompact = false;

    // The JSON response looks like this:

    // {
    //  "access_token":"12345",
    //  "token_type":"bearer",
    //  "scope":"read_store_profile update_catalog",
    //  "store_id":1003,
    //  "email": "john@store.com",
    //  "public_token":"public_qKDUqKkNXzcj9DejkMUqEkYLq2E6BXM9"
    // }

    console.log(json.Emit());

    // Save the JSON to a file for future requests.
    var fac = new chilkat.FileAccess();
    fac.WriteEntireTextFile("qa_data/tokens/ecwid.json",json.Emit(),"utf-8",false);

}

chilkatExample();