PureBasic

Salesforce OAuth2 Refresh Access Token

See more OAuth2 Examples

Demonstrates how to refresh a Salesforce Access Token.

Note: Use Chilkat v10.1.2 or later for this example.

PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; It is assumed we previously obtained an OAuth2 access token.
    ; This example loads the JSON access token file 
    ; saved by this example: Get SalesForce OAuth2 Access Token via Authorization Flow

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

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/_salesforce.json")
    If success <> 1
        Debug "Failed to load _salesforce.json"
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    ; This is an example of a Salesforce OAuth2 access token to be refreshed:

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

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

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

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

    ; Note: The client secret is not required because we configured our Connected App
    ; to not require it for the refresh flow.  See the screenshot below.

    ; Get the "refresh_token"
    CkOAuth2::setCkRefreshToken(oauth2, CkJsonObject::ckStringOf(jsonToken,"refresh_token"))

    ; Send the HTTP POST to refresh the access token..
    success = CkOAuth2::ckRefreshAccessToken(oauth2)
    If success <> 1
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; The response contains a new access token, but we must keep
    ; our existing refresh token for when we need to refresh again in the future.
    CkJsonObject::ckUpdateString(jsonToken,"access_token",CkOAuth2::ckAccessToken(oauth2))

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

    CkJsonObject::setCkEmitCompact(jsonToken, 0)
    CkJsonObject::ckEmitSb(jsonToken,sbJson)
    CkStringBuilder::ckWriteFile(sbJson,"qa_data/tokens/_salesforce.json","utf-8",0)

    Debug "OAuth2 authorization granted!"
    Debug "New Access Token = " + CkOAuth2::ckAccessToken(oauth2)

    ; --------------------------------------------------------------------------
    ; Here's a screenshot of a Salesforce Connected App 
    ; which does not requires the secret for the authorization or refresh flow.
    ; 


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


    ProcedureReturn
EndProcedure