Java

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). Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.FileAccess;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.OAuth2;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        OAuth2 oauth2 = new 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.setListenPort(3017);

        oauth2.setAuthorizationEndpoint("https://id.getharvest.com/oauth2/authorize");
        oauth2.setTokenEndpoint("https://id.getharvest.com/api/v2/oauth2/token");

        // Replace these with actual values.
        oauth2.setClientId("CLIENT_ID");
        oauth2.setClientSecret("CLIENT_SECRET");

        oauth2.setCodeChallenge(false);

        oauth2.setScope("all");

        // Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
        String url;
        try {
            url = oauth2.startAuth();

            // Launch the system's default browser navigated to the URL.
            oauth2.launchBrowser(url);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Now wait for the authorization.
        // We'll wait for a max of 60 seconds.
        int numMsWaited = 0;
        while ((numMsWaited < 60000) && (oauth2.getAuthFlowState() < 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.getAuthFlowState() < 3) {
            oauth2.cancel();
            System.out.println("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.getAuthFlowState() == 5) {
            System.out.println("OAuth2 failed to complete.");
            System.out.println(oauth2.getFailureInfo());
            return;
        }

        if (oauth2.getAuthFlowState() == 4) {
            System.out.println("OAuth2 authorization was denied.");
            System.out.println(oauth2.getAccessTokenResponse());
            return;
        }

        if (oauth2.getAuthFlowState() != 3) {
            System.out.println("Unexpected AuthFlowState:" + oauth2.getAuthFlowState());
            return;
        }

        System.out.println("OAuth2 authorization granted!");
        System.out.println("Access Token = " + oauth2.getAccessToken());

        // Get the full JSON response:
        JsonObject json = new JsonObject();
        json.load(oauth2.getAccessTokenResponse());
        json.setEmitCompact(false);
        System.out.println(json.emit());

        // The JSON response looks like this:

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