Java

Twinfield OAuth2 for Desktop App or Script

See more OAuth2 Examples

Demonstrates how to get a Twinfield OAuth2 access token from a desktop application or script. Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    // For more information about the OAuth2, see OAuth 2.0 Authorization Flow

    CkOAuth2 oauth2 = new CkOAuth2();

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

    oauth2.put_AuthorizationEndpoint("https://login.twinfield.com/auth/authentication/connect/authorize");
    oauth2.put_TokenEndpoint("https://login.twinfield.com/auth/authentication/connect/token");

    // Replace these with actual values.
    oauth2.put_ClientId("CLIENT_ID");
    oauth2.put_ClientSecret("CLIENT_SECRET");

    oauth2.put_Scope("openid twf.user twf.organisation twf.organisationUser offline_access");

    oauth2.put_CodeChallenge(true);
    oauth2.put_CodeChallengeMethod("S256");

    // Twinfield requires that the request to exchange the authorization code for a token must be a GET.
    // (In most cases, OAuth2 is implemented where the exchange for token HTTP request is a POST.)
    // Note: The exchange-for-token happens within Chilkat in a background thread.  After the user interactively 
    // accepts or denies authorization, the browser receives the response and redirects to localhost:<port>,
    // where Chilkat is waiting on a background thread to receive the redirect, process it, and then send the HTTP request
    // to exchange the code for a token.  This happens internally while your code below is waiting for the authorization..)
    oauth2.put_UncommonOptions("EXCHANGE_CODE_FOR_TOKEN_USING_GET");

    // Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    String url = oauth2.startAuth();
    if (oauth2.get_LastMethodSuccess() != true) {
        System.out.println(oauth2.lastErrorText());
        return;
        }

    System.out.println("url = " + url);

    // 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) {
        System.out.println(oauth2.lastErrorText());
        return;
        }

    // Wait for the user to approve or deny authorization in the browser.
    int numMsWaited = 0;
    while ((numMsWaited < 90000) && (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();
        System.out.println("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.get_AuthFlowState() == 5) {
        System.out.println("OAuth2 failed to complete.");
        System.out.println(oauth2.failureInfo());
        return;
        }

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

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

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

    // Get the full JSON response:
    CkJsonObject json = new CkJsonObject();
    json.Load(oauth2.accessTokenResponse());
    json.put_EmitCompact(false);

    // The JSON response looks like this:

    System.out.println(json.emit());

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