PureBasic

Isabel Connect Create Access Token given Valid Refresh Token

See more Ibanity Examples

Create (refresh) an access token given a valid refresh token. PureBasic

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkCrypt2.pb"
IncludeFile "CkHttpRequest.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkStringBuilder.pb"

Procedure ChilkatExample()

    success.i = 0

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

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

    ; Implements the following CURL command:

    ; curl -X POST https://api.ibanity.com/isabel-connect/oauth2/token \
    ; --cert certificate.pem:qwertyuiop1 \
    ; --key private_key.pem  \
    ; -H "Content-Type: application/x-www-form-urlencoded" \
    ; -H "Accept: application/vnd.api+json" \
    ; -H "Ibanity-Idempotency-Key: 94c5586e-e15e-4bae-a1fe-fdbefe1f11d3"  \
    ; -d grant_type=refresh_token \
    ; -d refresh_token=valid_refresh_token \
    ; -d client_id=valid_client_id \
    ; -d client_secret=valid_client_secret

    ; Ibanity provides the certificate + private key in PFX format.  This example will use the .pfx instead of the pair of PEM files.
    ; (It is also possible to implement using Chilkat with the PEM files, but PFX is easier.)
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkCert::ckLoadPfxFile(cert,"qa_data/pfx/my_ibanity_certificate.pfx","my_pfx_password")
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkHttp::ckDispose(http)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkHttp::ckSetSslClientCert(http,cert)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

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

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/isabel-connect/oauth2/token")
    CkHttpRequest::setCkContentType(req, "application/x-www-form-urlencoded")
    CkHttpRequest::ckAddParam(req,"grant_type","refresh_token")

    ; Load the previously obtained refresh token.
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/isabel_refresh_token.json")
    If success = 0
        Debug "No existing access token."
        CkHttp::ckDispose(http)
        CkCert::ckDispose(cert)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    CkHttpRequest::ckAddParam(req,"refresh_token",CkJsonObject::ckStringOf(jsonToken,"refresh_token"))

    ; Note: For sandbox testing, we literally want to use the strings
    ; "valid_client_id", and "valid_client_secret".
    ; For the live app, you would replace these with actual values.
    CkHttpRequest::ckAddParam(req,"client_id","valid_client_id")
    CkHttpRequest::ckAddParam(req,"client_secret","valid_client_secret")

    CkHttpRequest::ckAddHeader(req,"Accept","application/vnd.api+json")

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

    idempotencyKey.s = CkCrypt2::ckGenerateUuid(crypt)
    Debug "Ibanity-Idempotency-Key: " + idempotencyKey
    CkHttpRequest::ckAddHeader(req,"Ibanity-Idempotency-Key",idempotencyKey)

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

    success = CkHttp::ckHttpReq(http,"https://api.ibanity.com/isabel-connect/oauth2/token",req,resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkCert::ckDispose(cert)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(jsonToken)
        CkCrypt2::ckDispose(crypt)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

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

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkCert::ckDispose(cert)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(jsonToken)
        CkCrypt2::ckDispose(crypt)
        CkHttpResponse::ckDispose(resp)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; Notice that we don't get a new refresh token.  The original refresh token is used each time we
    ; want to refresh.  However, we get a new access token.  This access token is to be used in Isabel API calls
    ; until we need to refresh again.
    ; {
    ;   "token_type": "Bearer",
    ;   "scope": "cloudconnect",
    ;   "expires_in": 1799,
    ;   "access_token": "access_token_1603365408"
    ; }

    ; Sample code for parsing the JSON response...
    ; Use the following online tool to generate parsing code from sample JSON:
    ; Generate Parsing Code from JSON

    token_type.s = CkJsonObject::ckStringOf(jResp,"token_type")
    scope.s = CkJsonObject::ckStringOf(jResp,"scope")
    expires_in.i = CkJsonObject::ckIntOf(jResp,"expires_in")
    access_token.s = CkJsonObject::ckStringOf(jResp,"access_token")

    ; Save this to a file so we can load in other examples to include the access token in the HTTP request.
    success = CkJsonObject::ckWriteFile(jResp,"qa_data/tokens/isabel_access_token.json")


    CkHttp::ckDispose(http)
    CkCert::ckDispose(cert)
    CkHttpRequest::ckDispose(req)
    CkJsonObject::ckDispose(jsonToken)
    CkCrypt2::ckDispose(crypt)
    CkHttpResponse::ckDispose(resp)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure