AutoIt

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

Local $bSuccess = False

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

$oOauth2 = ObjCreate("Chilkat.OAuth2")

; 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
$oOauth2.LocalHost = "127.0.0.1"
$oOauth2.ListenPort = 3017

$oOauth2.AuthorizationEndpoint = "https://x.com/i/oauth2/authorize"
$oOauth2.TokenEndpoint = "https://api.x.com/2/oauth2/token"

; Replace this with your actual X.com OAuth2 Client ID and Client Secret
$oOauth2.ClientId = "OAUTH2_CLIENT_ID"
$oOauth2.ClientSecret = "OAUTH2_CLIENT_SECRET"

; This is for Require Proof Key for Code Exchange (PKCE)
; See OAuth2 PKCE Explained
$oOauth2.CodeChallenge = True
$oOauth2.CodeChallengeMethod = "S256"

; Space separated scopes...
$oOauth2.Scope = "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.
Local $sUrl = $oOauth2.StartAuth()
If ($oOauth2.LastMethodSuccess <> True) Then
    ConsoleWrite($oOauth2.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("url = " & $sUrl & @CRLF)

; Launch the default browser on the system and navigate to the url.
; The LaunchBrowser method was added in Chilkat v10.1.2.
$bSuccess = $oOauth2.LaunchBrowser($sUrl)
If ($bSuccess = False) Then
    ConsoleWrite($oOauth2.LastErrorText & @CRLF)
    Exit
EndIf

; Wait for the user to approve or deny authorization in the browser.
Local $iNumMsWaited = 0
While ($iNumMsWaited < 10000) And ($oOauth2.AuthFlowState < 3)
    $oOauth2.SleepMs 100
    $iNumMsWaited = $iNumMsWaited + 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 ($oOauth2.AuthFlowState < 3) Then
    $oOauth2.Cancel()
    ConsoleWrite("No response from the browser!" & @CRLF)
    Exit
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 ($oOauth2.AuthFlowState = 5) Then
    ConsoleWrite("OAuth2 failed to complete." & @CRLF)
    ConsoleWrite($oOauth2.FailureInfo & @CRLF)
    Exit
EndIf

If ($oOauth2.AuthFlowState = 4) Then
    ConsoleWrite("OAuth2 authorization was denied." & @CRLF)
    ConsoleWrite($oOauth2.AccessTokenResponse & @CRLF)
    Exit
EndIf

If ($oOauth2.AuthFlowState <> 3) Then
    ConsoleWrite("Unexpected AuthFlowState:" & $oOauth2.AuthFlowState & @CRLF)
    Exit
EndIf

ConsoleWrite("OAuth2 authorization granted!" & @CRLF)

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.Load($oOauth2.AccessTokenResponse)
$oJson.EmitCompact = 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 ($oJson.HasMember("expires_on") = False) Then
    $oDtExpire = ObjCreate("Chilkat.CkDateTime")
    $oDtExpire.SetFromCurrentSystemTime()
    $oDtExpire.AddSeconds($oJson.IntOf("expires_in"))
    $oJson.AppendString("expires_on",$oDtExpire.GetAsUnixTimeStr(False))
EndIf

ConsoleWrite("Access Token Response = " & $oJson.Emit() & @CRLF)

; 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"
; }

ConsoleWrite("Access Token = " & $oOauth2.AccessToken & @CRLF)

ConsoleWrite("Refresh Token = " & $oOauth2.RefreshToken & @CRLF)

; Save the JSON access token response to a file for subsequent use..
$oJson.WriteFile("qa_data/tokens/x.json")

;