(Lianja) Schwab OAuth2 in a Desktop App

See more Schwab Examples

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat Lianja Extension Download Chilkat Lianja Extension

llSuccess = .F.

// To further clarify, see OAuth 2.0 Authorization Flow

// This is the way to initially obtain the OAuth2 access token.  Afterwards it can be 
// repeatedly refreshed without user interaction, as shown in this example: Refresh Schwab OAuth2 Access Token.

loOauth2 = createobject("CkOAuth2")

// Your applicaton must use your own public web server as an intermediate
// to receive and forward the redirect to localhost.
// See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost

loOauth2.AppCallbackUrl = "https://yourwebserver.com/OAuth2.php"
loOauth2.ListenPort = 3017

loOauth2.AuthorizationEndpoint = "https://api.schwabapi.com/v1/oauth/authorize"
loOauth2.TokenEndpoint = "https://api.schwabapi.com/v1/oauth/token"

// Replace these with actual values.
loOauth2.ClientId = "APP_KEY"
loOauth2.ClientSecret = "APP_SECRET"
loOauth2.UseBasicAuth = .T.
loOauth2.CodeChallenge = .F.

loOauth2.Scope = ""

// Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
lcUrl = loOauth2.StartAuth()
if (loOauth2.LastMethodSuccess = .F.) then
    ? loOauth2.LastErrorText
    release loOauth2
    return
endif

? "url = " + lcUrl

// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
llSuccess = loOauth2.LaunchBrowser(lcUrl)
if (llSuccess = .F.) then
    ? loOauth2.LastErrorText
    release loOauth2
    return
endif

// Wait for the user to approve or deny authorization in the browser.
lnNumMsWaited = 0
do while (lnNumMsWaited < 90000) and (loOauth2.AuthFlowState < 3)
    loOauth2.SleepMs(100)
    lnNumMsWaited = lnNumMsWaited + 100
enddo

// 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 (loOauth2.AuthFlowState < 3) then
    loOauth2.Cancel()
    ? "No response from the browser!"
    release loOauth2
    return
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 (loOauth2.AuthFlowState = 5) then
    ? "OAuth2 failed to complete."
    ? loOauth2.FailureInfo
    release loOauth2
    return
endif

if (loOauth2.AuthFlowState = 4) then
    ? "OAuth2 authorization was denied."
    ? loOauth2.AccessTokenResponse
    release loOauth2
    return
endif

if (loOauth2.AuthFlowState <> 3) then
    ? "Unexpected AuthFlowState:" + str(loOauth2.AuthFlowState)
    release loOauth2
    return
endif

// Save the full JSON access token response to a file.
loSbJson = createobject("CkStringBuilder")
loSbJson.Append(loOauth2.AccessTokenResponse)
loSbJson.WriteFile("qa_data/tokens/schwab-access-token.json","utf-8",.F.)

// The full JSON received looks like this:
// {
//   "expires_in": 3600,
//   "x_refresh_token_expires_in": 8726400,
//   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
//   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
//   "token_type": "bearer"
// }

? "OAuth2 authorization granted!"
? "Access Token = " + loOauth2.AccessToken


release loOauth2
release loSbJson