Node.js

GetHarvest API V2 OAuth Token

See more GetHarvest Examples

Demonstrates how to get an OAuth2 access token for the GetHarvest v2 API (from a desktop application). Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    var oauth2 = new chilkat.OAuth2();

    // 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://id.getharvest.com/oauth2/authorize";
    oauth2.TokenEndpoint = "https://id.getharvest.com/api/v2/oauth2/token";

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

    oauth2.CodeChallenge = false;

    oauth2.Scope = "all";

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

    // Launch the system's default browser navigated to the URL.
    success = oauth2.LaunchBrowser(url);
    if (success == false) {
        console.log(oauth2.LastErrorText);
        return;
    }

    // Now wait for the authorization.
    // We'll wait for a max of 60 seconds.
    var numMsWaited = 0;
    while ((numMsWaited < 60000) && (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;
    console.log(json.Emit());

    // The JSON response looks like this:

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

}

chilkatExample();