C

Square OAuth2 Access Token

See more Square Examples

Demonstrates how to get an access token for the Square API. This example is for desktop apps only (not web apps). C

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

void ChilkatSample(void)
    {
    BOOL success;
    HCkOAuth2 oauth2;
    const char *url;
    HCkStringBuilder sbUrl;
    int numMsWaited;
    HCkJsonObject json;
    HCkFileAccess fac;

    success = FALSE;

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

    oauth2 = CkOAuth2_Create();

    // 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.
    CkOAuth2_putListenPort(oauth2,3017);

    // To use the production system, change the domains here to "connect.squareup.com"
    CkOAuth2_putAuthorizationEndpoint(oauth2,"https://connect.squareupsandbox.com/oauth2/authorize");
    CkOAuth2_putTokenEndpoint(oauth2,"https://connect.squareupsandbox.com/oauth2/token");

    // Replace these with actual values.
    CkOAuth2_putClientId(oauth2,"APPLICATION_ID");
    CkOAuth2_putClientSecret(oauth2,"APPLICATION_SECRET");

    // Make sure to include the scopes you'll need.
    CkOAuth2_putScope(oauth2,"ITEMS_WRITE ITEMS_READ");

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

    // Add the session=False query param to the URL.
    sbUrl = CkStringBuilder_Create();
    CkStringBuilder_Append(sbUrl,url);
    CkStringBuilder_Append(sbUrl,"&session=False");
    // Launch this URL in the browser.
    url = CkStringBuilder_getAsString(sbUrl);

    // Launch the system's default browser navigated to the URL.
    success = CkOAuth2_LaunchBrowser(oauth2,url);
    if (success == FALSE) {
        printf("%s\n",CkOAuth2_lastErrorText(oauth2));
        CkOAuth2_Dispose(oauth2);
        CkStringBuilder_Dispose(sbUrl);
        return;
    }

    // Now wait for the authorization.
    // We'll wait for a max of 30 seconds.
    numMsWaited = 0;
    while ((numMsWaited < 30000) && (CkOAuth2_getAuthFlowState(oauth2) < 3)) {
        CkOAuth2_SleepMs(oauth2,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 (CkOAuth2_getAuthFlowState(oauth2) < 3) {
        CkOAuth2_Cancel(oauth2);
        printf("No response from the browser!\n");
        CkOAuth2_Dispose(oauth2);
        CkStringBuilder_Dispose(sbUrl);
        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 (CkOAuth2_getAuthFlowState(oauth2) == 5) {
        printf("OAuth2 failed to complete.\n");
        printf("%s\n",CkOAuth2_failureInfo(oauth2));
        CkOAuth2_Dispose(oauth2);
        CkStringBuilder_Dispose(sbUrl);
        return;
    }

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

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

    printf("OAuth2 authorization granted!\n");
    printf("Access Token = %s\n",CkOAuth2_accessToken(oauth2));

    // Get the full JSON response:
    json = CkJsonObject_Create();
    CkJsonObject_Load(json,CkOAuth2_accessTokenResponse(oauth2));
    CkJsonObject_putEmitCompact(json,FALSE);

    // The JSON response looks like this:

    // {
    //   "access_token": "EAAAE...depV",
    //   "token_type": "bearer",
    //   "expires_at": "2020-09-04T23:30:18Z",
    //   "merchant_id": "MLQA83866KSR5",
    //   "refresh_token": "EQAAEE...jeVfD6MV"
    // }

    printf("%s\n",CkJsonObject_emit(json));

    // Save the JSON to a file for future requests.
    fac = CkFileAccess_Create();
    CkFileAccess_WriteEntireTextFile(fac,"qa_data/tokens/square.json",CkJsonObject_emit(json),"utf-8",FALSE);


    CkOAuth2_Dispose(oauth2);
    CkStringBuilder_Dispose(sbUrl);
    CkJsonObject_Dispose(json);
    CkFileAccess_Dispose(fac);

    }