Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/api/balances/",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "count": "<integer>",
; "next": "<string>",
; "previous": "<string>",
; "results": [
; {
; "id": "<uuid>",
; "account": {
; "id": "<uuid>",
; "name": "<string>",
; "category": "irure",
; "currency": "<string>"
; },
; "collected_at": "<dateTime>",
; "value_date": "<date>",
; "balance": "<number>",
; "current_balance": "<number>",
; "statement": "<string>"
; },
; {
; "id": "<uuid>",
; "account": {
; "id": "<uuid>",
; "name": "<string>",
; "category": "in culpa cupidatat ullamco",
; "currency": "<string>"
; },
; "collected_at": "<dateTime>",
; "value_date": "<date>",
; "balance": "<number>",
; "current_balance": "<number>",
; "statement": "<string>"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
Id.s
Name.s
Category.s
v_Currency.s
collected_at.s
value_date.s
balance.s
current_balance.s
statement.s
count.s = CkJsonObject::ckStringOf(jResp,"count")
v_next.s = CkJsonObject::ckStringOf(jResp,"next")
previous.s = CkJsonObject::ckStringOf(jResp,"previous")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"results[i].id")
Id = CkJsonObject::ckStringOf(jResp,"results[i].account.id")
Name = CkJsonObject::ckStringOf(jResp,"results[i].account.name")
Category = CkJsonObject::ckStringOf(jResp,"results[i].account.category")
v_Currency = CkJsonObject::ckStringOf(jResp,"results[i].account.currency")
collected_at = CkJsonObject::ckStringOf(jResp,"results[i].collected_at")
value_date = CkJsonObject::ckStringOf(jResp,"results[i].value_date")
balance = CkJsonObject::ckStringOf(jResp,"results[i].balance")
current_balance = CkJsonObject::ckStringOf(jResp,"results[i].current_balance")
statement = CkJsonObject::ckStringOf(jResp,"results[i].statement")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/balances/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/balances/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set.",
"disabled": true
}
]
},
"description": "Get a paginated list of all existing balances in your Belvo account. We return up to 100 results per page."
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/balances?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
],
"query": [
{
"key": "page",
"value": "<integer>"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"count\": \"<integer>\",\n\t\"next\": \"<string>\",\n\t\"previous\": \"<string>\",\n\t\"results\": [\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"category\": \"irure\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"value_date\": \"<date>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"current_balance\": \"<number>\",\n\t\t\t\"statement\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"category\": \"in culpa cupidatat ullamco\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"value_date\": \"<date>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"current_balance\": \"<number>\",\n\t\t\t\"statement\": \"<string>\"\n\t\t}\n\t]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/balances?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
],
"query": [
{
"key": "page",
"value": "<integer>"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
