Go

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. Go

    success := false

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

    oauth2 := chilkat.NewOAuth2()

    // 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://login.twinfield.com/auth/authentication/connect/authorize")
    oauth2.SetTokenEndpoint("https://login.twinfield.com/auth/authentication/connect/token")

    // Replace these with actual values.
    oauth2.SetClientId("CLIENT_ID")
    oauth2.SetClientSecret("CLIENT_SECRET")

    oauth2.SetScope("openid twf.user twf.organisation twf.organisationUser offline_access")

    oauth2.SetCodeChallenge(true)
    oauth2.SetCodeChallengeMethod("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.SetUncommonOptions("EXCHANGE_CODE_FOR_TOKEN_USING_GET")

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

    fmt.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 {
        fmt.Println(oauth2.LastErrorText())
        oauth2.DisposeOAuth2()
        return
    }

    // Wait for the user to approve or deny authorization in the browser.
    numMsWaited := 0
    for (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()
        fmt.Println("No response from the browser!")
        oauth2.DisposeOAuth2()
        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 {
        fmt.Println("OAuth2 failed to complete.")
        fmt.Println(oauth2.FailureInfo())
        oauth2.DisposeOAuth2()
        return
    }

    if oauth2.AuthFlowState() == 4 {
        fmt.Println("OAuth2 authorization was denied.")
        fmt.Println(oauth2.AccessTokenResponse())
        oauth2.DisposeOAuth2()
        return
    }

    if oauth2.AuthFlowState() != 3 {
        fmt.Println("Unexpected AuthFlowState:", oauth2.AuthFlowState())
        oauth2.DisposeOAuth2()
        return
    }

    fmt.Println("OAuth2 authorization granted!")
    fmt.Println("Access Token = ", oauth2.AccessToken())

    // Get the full JSON response:
    json := chilkat.NewJsonObject()
    json.Load(oauth2.AccessTokenResponse())
    json.SetEmitCompact(false)

    // The JSON response looks like this:

    fmt.Println(*json.Emit())

    // Save the JSON to a file for future requests.
    fac := chilkat.NewFileAccess()
    fac.WriteEntireTextFile("qa_data/tokens/twinfield.json",*json.Emit(),"utf-8",false)

    oauth2.DisposeOAuth2()
    json.DisposeJsonObject()
    fac.DisposeFileAccess()