PureBasic

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

IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

    success.i = 0

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

    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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
    CkOAuth2::setCkLocalHost(oauth2, "127.0.0.1")
    CkOAuth2::setCkListenPort(oauth2, 3017)

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://x.com/i/oauth2/authorize")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://api.x.com/2/oauth2/token")

    ; Replace this with your actual X.com OAuth2 Client ID and Client Secret
    CkOAuth2::setCkClientId(oauth2, "OAUTH2_CLIENT_ID")
    CkOAuth2::setCkClientSecret(oauth2, "OAUTH2_CLIENT_SECRET")

    ; This is for Require Proof Key for Code Exchange (PKCE)
    ; See OAuth2 PKCE Explained
    CkOAuth2::setCkCodeChallenge(oauth2, 1)
    CkOAuth2::setCkCodeChallengeMethod(oauth2, "S256")

    ; Space separated scopes...
    CkOAuth2::setCkScope(oauth2, "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.s = CkOAuth2::ckStartAuth(oauth2)
    If CkOAuth2::ckLastMethodSuccess(oauth2) <> 1
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "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 = CkOAuth2::ckLaunchBrowser(oauth2,url)
    If success = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Wait for the user to approve or deny authorization in the browser.
    numMsWaited.i = 0
    While (numMsWaited < 10000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3)
        CkOAuth2::ckSleepMs(oauth2,100)
        numMsWaited = numMsWaited + 100
    Wend

    ; 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::ckAuthFlowState(oauth2) < 3
        CkOAuth2::ckCancel(oauth2)
        Debug "No response from the browser!"
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; 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::ckAuthFlowState(oauth2) = 5
        Debug "OAuth2 failed to complete."
        Debug CkOAuth2::ckFailureInfo(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) = 4
        Debug "OAuth2 authorization was denied."
        Debug CkOAuth2::ckAccessTokenResponse(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) <> 3
        Debug "Unexpected AuthFlowState:" + Str(CkOAuth2::ckAuthFlowState(oauth2))
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "OAuth2 authorization granted!"

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,CkOAuth2::ckAccessTokenResponse(oauth2))
    CkJsonObject::setCkEmitCompact(json, 0)

    ; 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 CkJsonObject::ckHasMember(json,"expires_on") = 0
        dtExpire.i = CkDateTime::ckCreate()
        If dtExpire.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        CkDateTime::ckSetFromCurrentSystemTime(dtExpire)
        CkDateTime::ckAddSeconds(dtExpire,CkJsonObject::ckIntOf(json,"expires_in"))
        CkJsonObject::ckAppendString(json,"expires_on",CkDateTime::ckGetAsUnixTimeStr(dtExpire,0))
    EndIf

    Debug "Access Token Response = " + CkJsonObject::ckEmit(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"
    ; }

    Debug "Access Token = " + CkOAuth2::ckAccessToken(oauth2)

    Debug "Refresh Token = " + CkOAuth2::ckRefreshToken(oauth2)

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

    ; 


    CkOAuth2::ckDispose(oauth2)
    CkJsonObject::ckDispose(json)
    CkDateTime::ckDispose(dtExpire)


    ProcedureReturn
EndProcedure