Unicode C

X.com OAuth 2.0 Authorization Code with PKCE

See more X Examples

Demonstrates how to get an X.com OAuth2 access token from a desktop application or script. Unicode C

#include <C_CkOAuth2W.h>
#include <C_CkJsonObjectW.h>
#include <C_CkDateTimeW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkOAuth2W oauth2;
    const wchar_t *url;
    int numMsWaited;
    HCkJsonObjectW json;
    HCkDateTimeW dtExpire;

    success = FALSE;

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

    oauth2 = CkOAuth2W_Create();

    // The port should match the Authorized Redirect URL in your X.com app, 
    // which would look like "http://127.0.0.1:3017/"
    // See the screenshot below of the App Settings in the X Developer Portal
    CkOAuth2W_putLocalHost(oauth2,L"127.0.0.1");
    CkOAuth2W_putListenPort(oauth2,3017);

    CkOAuth2W_putAuthorizationEndpoint(oauth2,L"https://x.com/i/oauth2/authorize");
    CkOAuth2W_putTokenEndpoint(oauth2,L"https://api.x.com/2/oauth2/token");

    // Replace this with your actual X.com OAuth2 Client ID and Client Secret
    CkOAuth2W_putClientId(oauth2,L"OAUTH2_CLIENT_ID");
    CkOAuth2W_putClientSecret(oauth2,L"OAUTH2_CLIENT_SECRET");

    // This is for Require Proof Key for Code Exchange (PKCE)
    // See OAuth2 PKCE Explained
    CkOAuth2W_putCodeChallenge(oauth2,TRUE);
    CkOAuth2W_putCodeChallengeMethod(oauth2,L"S256");

    // Space separated scopes...
    CkOAuth2W_putScope(oauth2,L"tweet.read tweet.write users.read follows.read follows.write offline.access like.read like.write block.read block.write");

    // Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    url = CkOAuth2W_startAuth(oauth2);
    if (CkOAuth2W_getLastMethodSuccess(oauth2) != TRUE) {
        wprintf(L"%s\n",CkOAuth2W_lastErrorText(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    wprintf(L"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 = CkOAuth2W_LaunchBrowser(oauth2,url);
    if (success == FALSE) {
        wprintf(L"%s\n",CkOAuth2W_lastErrorText(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    // Wait for the user to approve or deny authorization in the browser.
    numMsWaited = 0;
    while ((numMsWaited < 10000) && (CkOAuth2W_getAuthFlowState(oauth2) < 3)) {
        CkOAuth2W_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 (CkOAuth2W_getAuthFlowState(oauth2) < 3) {
        CkOAuth2W_Cancel(oauth2);
        wprintf(L"No response from the browser!\n");
        CkOAuth2W_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 (CkOAuth2W_getAuthFlowState(oauth2) == 5) {
        wprintf(L"OAuth2 failed to complete.\n");
        wprintf(L"%s\n",CkOAuth2W_failureInfo(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    if (CkOAuth2W_getAuthFlowState(oauth2) == 4) {
        wprintf(L"OAuth2 authorization was denied.\n");
        wprintf(L"%s\n",CkOAuth2W_accessTokenResponse(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    if (CkOAuth2W_getAuthFlowState(oauth2) != 3) {
        wprintf(L"Unexpected AuthFlowState:%d\n",CkOAuth2W_getAuthFlowState(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    wprintf(L"OAuth2 authorization granted!\n");

    json = CkJsonObjectW_Create();
    CkJsonObjectW_Load(json,CkOAuth2W_accessTokenResponse(oauth2));
    CkJsonObjectW_putEmitCompact(json,FALSE);

    // If an "expires_on" member does not exist, then add the JSON member by
    // getting the current system date/time and adding the "expires_in" seconds.
    // This way we'll know when the token expires.
    if (CkJsonObjectW_HasMember(json,L"expires_on") == FALSE) {
        dtExpire = CkDateTimeW_Create();
        CkDateTimeW_SetFromCurrentSystemTime(dtExpire);
        CkDateTimeW_AddSeconds(dtExpire,CkJsonObjectW_IntOf(json,L"expires_in"));
        CkJsonObjectW_AppendString(json,L"expires_on",CkDateTimeW_getAsUnixTimeStr(dtExpire,FALSE));
    }

    wprintf(L"Access Token Response = %s\n",CkJsonObjectW_emit(json));

    // A sample access token response:

    // {
    //   "token_type": "bearer",
    //   "expires_in": 7200,
    //   "access_token": "VmNDLVZiYUZwejY5Mkx3RblFTmo3ek1leTRGclMuZFVOUTVUTWpNbVZKb1N5OjE3NDAxNjk4MDVxNTE6MToxOaF0OjE",
    //   "scope": "block.read follows.read offline.access tweet.write block.write like.write like.read users.read tweet.read follows.write",
    //   "refresh_token": "eThOWVVFSTRqdVp3QTFndGsxM2ZGZmFyNWVrU0phM1JKbGdrbGNWRGJzb1loOjE3NDAwMjk4MDUxNTI6MTowOnJ0OjE"
    // }

    wprintf(L"Access Token = %s\n",CkOAuth2W_accessToken(oauth2));

    wprintf(L"Refresh Token = %s\n",CkOAuth2W_refreshToken(oauth2));

    // Save the JSON access token response to a file for subsequent use..
    CkJsonObjectW_WriteFile(json,L"qa_data/tokens/x.json");

    // 


    CkOAuth2W_Dispose(oauth2);
    CkJsonObjectW_Dispose(json);
    CkDateTimeW_Dispose(dtExpire);

    }