(PureBasic) Rabobank OAuth2 Access Token

Demonstrates how to get an OAuth 2.0 access token to access Rabobank API's

Important: This example is for desktop apps only. (It is not for web-based applications.)

Your app defined in the Rabobank portal should look something like this. (Our test app is named "chilkat". You should name your app something else.)

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

For more information, see https://developer-sandbox.rabobank.nl/implementoauth2

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkFileAccess.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    ; 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

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

    ; IMPORTANT: Don't forget to subscribe your Rabobank application to the OAuth 2.0 services in the Rabobank Online Developer Portal.
    ; IMPORTANT: Don't forget to subscribe your Rabobank application to the OAuth 2.0 services in the Rabobank Online Developer Portal.
    ; IMPORTANT: Don't forget to subscribe your Rabobank application to the OAuth 2.0 services in the Rabobank Online Developer Portal.
    ; IMPORTANT: Don't forget to subscribe your Rabobank application to the OAuth 2.0 services in the Rabobank Online Developer Portal.

    ; See also https://developer.rabobank.nl/faq

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://api-sandbox.rabobank.nl/openapi/sandbox/oauth2/authorize")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://api-sandbox.rabobank.nl/openapi/sandbox/oauth2/token")

    ; Replace these with actual values.
    CkOAuth2::setCkClientId(oauth2, "YOUR_APP_CLIENT_ID")
    ; This is your app password:
    CkOAuth2::setCkClientSecret(oauth2, "YOUR_APP_CLIENT_SECRET")

    CkOAuth2::setCkCodeChallenge(oauth2, 0)
    ; Provide a SPACE separated list of scopes, as defined in the Rabobank API documentation, 
    ; such as at https://developer-sandbox.rabobank.nl/reference/accounts-ais-sb/3-0-8

    ; Important: To get a refresh token in the final response, you have to ask for "offline_access" scope
    CkOAuth2::setCkScope(oauth2, "ais.balances.read ais.transactions.read-90days ais.transactions.read-history")

    ; 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.i = 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)

    ; Get the full JSON response:
    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)

    ; The JSON response looks like this:

    ; {
    ;   "token_type": "Bearer",
    ;   "access_token": "AAIkYTU0ZWM ... sxE0KL0HHWw",
    ;   "expires_in": 3600,
    ;   "consented_on": 1584641121,
    ;   "scope": "ais.balances.read ais.transactions.read-90days ais.transactions.read-history",
    ;   "refresh_token": "AAJXXSdN ... Uiblz9ILkxNBlytRGA",
    ;   "refresh_token_expires_in": 157784760,
    ;   "expires_on": "1584644722"
    ; }

    Debug CkJsonObject::ckEmit(json)

    ; Save the JSON to a file to be used in future requests.
    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkFileAccess::ckWriteEntireTextFile(fac,"qa_data/tokens/rabobank.json",CkJsonObject::ckEmit(json),"utf-8",0)


    CkOAuth2::ckDispose(oauth2)
    CkJsonObject::ckDispose(json)
    CkFileAccess::ckDispose(fac)


    ProcedureReturn
EndProcedure