C

Get a Xero OAuth2 Access Token

See more OAuth2 Examples

Gets a Xero OAuth2 access token. C

#include <C_CkOAuth2.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkOAuth2 oauth2;
    const char *url;
    int numMsWaited;
    HCkStringBuilder sbJson;

    success = FALSE;

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

    oauth2 = CkOAuth2_Create();

    // For Xero OAuth2, set the listen port equal to the port used
    // in the Authorized Redirect URL for the Client ID.
    // For example, in this case the Authorized Redirect URL would be http://localhost:55568/
    // Your app should choose a port not likely not used by any other application.
    // See Xero OAuth2 for Desktop Apps for more information.
    CkOAuth2_putListenPort(oauth2,55568);

    CkOAuth2_putAuthorizationEndpoint(oauth2,"https://login.xero.com/identity/connect/authorize");
    CkOAuth2_putTokenEndpoint(oauth2,"https://identity.xero.com/connect/token");

    // Replace these with actual values.
    CkOAuth2_putClientId(oauth2,"XERO_APP_OAUTH2_CLIENT_ID");
    CkOAuth2_putClientSecret(oauth2,"XERO_APP_OAUTH2_CLIENT_SECRET");
    CkOAuth2_putUseBasicAuth(oauth2,TRUE);

    // See https://developer.xero.com/documentation/oauth2/scopes for a complete list of scopes.
    // You will need to change the scopes depending on what access is needed..
    CkOAuth2_putScope(oauth2,"openid profile email accounting.transactions accounting.attachments accounting.settings payroll.employees offline_access");

    // Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    url = CkOAuth2_startAuth(oauth2);
    if (CkOAuth2_getLastMethodSuccess(oauth2) != TRUE) {
        printf("%s\n",CkOAuth2_lastErrorText(oauth2));
        CkOAuth2_Dispose(oauth2);
        return;
    }

    printf("url = %s\n",url);

    // Launch the default browser on the system and navigate to the url.
    // The LaunchBrowser method was added in Chilkat v10.1.2.
    success = CkOAuth2_LaunchBrowser(oauth2,url);
    if (success == FALSE) {
        printf("%s\n",CkOAuth2_lastErrorText(oauth2));
        CkOAuth2_Dispose(oauth2);
        return;
    }

    // Wait for the user to approve or deny authorization in the browser.
    numMsWaited = 0;
    while ((numMsWaited < 90000) && (CkOAuth2_getAuthFlowState(oauth2) < 3)) {
        CkOAuth2_SleepMs(oauth2,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 (CkOAuth2_getAuthFlowState(oauth2) < 3) {
        CkOAuth2_Cancel(oauth2);
        printf("No response from the browser!\n");
        CkOAuth2_Dispose(oauth2);
        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 (CkOAuth2_getAuthFlowState(oauth2) == 5) {
        printf("OAuth2 failed to complete.\n");
        printf("%s\n",CkOAuth2_failureInfo(oauth2));
        CkOAuth2_Dispose(oauth2);
        return;
    }

    if (CkOAuth2_getAuthFlowState(oauth2) == 4) {
        printf("OAuth2 authorization was denied.\n");
        printf("%s\n",CkOAuth2_accessTokenResponse(oauth2));
        CkOAuth2_Dispose(oauth2);
        return;
    }

    if (CkOAuth2_getAuthFlowState(oauth2) != 3) {
        printf("Unexpected AuthFlowState:%d\n",CkOAuth2_getAuthFlowState(oauth2));
        CkOAuth2_Dispose(oauth2);
        return;
    }

    // Save the full JSON access token response to a file.
    sbJson = CkStringBuilder_Create();
    CkStringBuilder_Append(sbJson,CkOAuth2_accessTokenResponse(oauth2));
    CkStringBuilder_WriteFile(sbJson,"qa_data/tokens/xero-access-token.json","utf-8",FALSE);

    // The saved JSON response looks like this:

    // 	{
    // 	 "access_token": "...",
    // 	 "token_type": "Bearer",
    // 	 "expires_in": 3600,
    // 	 "refresh_token": "..."
    // 	}
    // 
    printf("OAuth2 authorization granted!\n");
    printf("Access Token = %s\n",CkOAuth2_accessToken(oauth2));


    CkOAuth2_Dispose(oauth2);
    CkStringBuilder_Dispose(sbJson);

    }