PureBasic Requires Chilkat v10.1.2+

Salesforce OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to get a Salesforce OAuth2 access token from a desktop application or script. PureBasic

IncludeFile "CkOAuth2.pb"
IncludeFile "CkStringBuilder.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  To further clarify, see OAuth 2.0 Authorization Flow

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

    ;  This should be the port in the localhost callback URL for your connected app.  
    ;  The callback URL would look like "http://localhost:3017/" if the port number is 3017.
    CkOAuth2::setCkListenPort(oauth2, 3017)

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://login.salesforce.com/services/oauth2/authorize")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://login.salesforce.com/services/oauth2/token")

    ;  Replace this with your actual client ID (Consumer Key)
    CkOAuth2::setCkClientId(oauth2, "CLIENT_ID")

    ;  We don't have to include the client secret.
    ;  See the screenshot of our Connected App below..

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

    ;  To force the OAuth consent screen to reappear (even if previously granted), use:
    CkOAuth2::ckAddAuthQueryParam(oauth2,"prompt","consent")

    ;  Begin the OAuth2 authorization 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

    ;  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 < 90000) 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!"
    Debug "Access Token = " + CkOAuth2::ckAccessToken(oauth2)

    ;  Save the full JSON access token response to a file.
    sbJson.i = CkStringBuilder::ckCreate()
    If sbJson.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbJson,CkOAuth2::ckAccessTokenResponse(oauth2))
    CkStringBuilder::ckWriteFile(sbJson,"qa_data/tokens/_salesforce.json","utf-8",0)

    ;  The saved JSON response looks like this:

    ;  {
    ;    "access_token": "00D41000....uLZBpT6",
    ;    "refresh_token": "5Aep....25xdGgkrV",
    ;    "signature": "cjTbSc5DvcKpaMoRTzuQTJLb1tcMw8LEO01flq4aMD4=",
    ;    "scope": "refresh_token id",
    ;    "instance_url": "https://d41000000f8a0eak-dev-ed.my.salesforce.com",
    ;    "id": "https://login.salesforce.com/id/00D41000000F8A0EAK/005410000....xAAE",
    ;    "token_type": "Bearer",
    ;    "issued_at": "1738348388166"
    ;  }

    ;  --------------------------------------------------------------------------
    ;  Here's a screenshot of a Salesforce Connected App 
    ;  with the correct Callback URL for this example,
    ;  and also selects "Require Proof Key for Code Exchange (PKCE)"
    ;  and does not requires the secret for the authorization or refresh flow,
    ;  and also allows for the Client Credentials flow.
    ;  


    CkOAuth2::ckDispose(oauth2)
    CkStringBuilder::ckDispose(sbJson)


    ProcedureReturn
EndProcedure