(PureBasic) citi Developer OAuth2 Client Credentials Grant

Get access token for your application credentials. You can use this for citi APIs which do not require customer credential verification and consent (e.g. Onboarding).

For more information, see https://sandbox.developerhub.citi.com/api/united-states/retail-bank/identity-security/authorize/documentation

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; 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

    success.i

    ; Implements the following CURL command:

    ; curl --request POST \
    ;   --url https://sandbox.apihub.citi.com/gcb/api/clientCredentials/oauth2/token/us/gcb \
    ;   --header 'accept: application/json' \
    ;   --user client-id:client-secret \
    ;   --header 'content-type: application/x-www-form-urlencoded' \
    ;   --data 'grant_type=client_credentials&scope=%2Fapi'

    CkHttp::setCkLogin(http, "client-id")
    CkHttp::setCkPassword(http, "client-secret")

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

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/gcb/api/clientCredentials/oauth2/token/us/gcb")
    CkHttpRequest::setCkContentType(req, "application/x-www-form-urlencoded")
    CkHttpRequest::ckAddParam(req,"grant_type","client_credentials")
    CkHttpRequest::ckAddParam(req,"scope","/api")
    CkHttpRequest::ckAddHeader(req,"accept","application/json")

    resp.i = CkHttp::ckPostUrlEncoded(http,"https://sandbox.apihub.citi.com/gcb/api/clientCredentials/oauth2/token/us/gcb",req)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        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."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    success = CkJsonObject::ckWriteFile(jResp,"qa_data/tokens/citi_client_credentials.json")
    If success = 0
        Debug "Failed to save JSON access token file."
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

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

    ;  {
    ;    "token_type": "bearer",
    ;    "access_token": "AAIkMjdh ... 3fsWb7zJ0s",
    ;    "expires_in": 1800,
    ;    "consented_on": 1584817860,
    ;    "scope": "/api"
    ;  }

    ;  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")
    access_token.s = CkJsonObject::ckStringOf(jResp,"access_token")
    expires_in.i = CkJsonObject::ckIntOf(jResp,"expires_in")
    consented_on.i = CkJsonObject::ckIntOf(jResp,"consented_on")
    scope.s = CkJsonObject::ckStringOf(jResp,"scope")


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure