Chilkat Online Tools

PureBasic / Belvo API Docs / Resume

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "{{secretId}}")
    CkHttp::setCkPassword(http, "{{secretPassword}}")

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "session": "<uuid>",
    ;   "token": "<string>",
    ;   "link": "<uuid>",
    ;   "save_data": true
    ; }

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

    CkJsonObject::ckUpdateString(json,"session","<uuid>")
    CkJsonObject::ckUpdateString(json,"token","<string>")
    CkJsonObject::ckUpdateString(json,"link","<uuid>")
    CkJsonObject::ckUpdateBool(json,"save_data",1)

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PATCH","https://domain.com/api/recurring-expenses/",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PATCH
	-u '{{secretId}}:{{secretPassword}}'
	-d '{
    "session": "<uuid>",
    "token": "<string>",
    "link": "<uuid>",
    "save_data": true
}'
https://domain.com/api/recurring-expenses/

Postman Collection Item JSON

{
  "name": "Resume",
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"session\": \"<uuid>\",\n    \"token\": \"<string>\",\n    \"link\": \"<uuid>\",\n    \"save_data\": true\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/recurring-expenses/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "recurring-expenses",
        ""
      ]
    },
    "description": "Used to resume an Recurring Expenses retrieve session that was paused because an MFA token was required by the institution."
  },
  "response": [
  ]
}