Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonArrayW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonArrayW jarrResp;
int respStatusCode;
HCkJsonObjectW json;
const wchar_t *id;
const wchar_t *Id;
const wchar_t *Name;
const wchar_t *Category;
const wchar_t *v_Currency;
const wchar_t *collected_at;
const wchar_t *value_date;
const wchar_t *balance;
const wchar_t *current_balance;
const wchar_t *statement;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"{{secretId}}");
CkHttpW_putPassword(http,L"{{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.
// {
// "date_from": "2021-01-01",
// "date_to": "2021-03-30",
// "link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
// "token": "1234ab",
// "save_data": true,
// "account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"date_from",L"2021-01-01");
CkJsonObjectW_UpdateString(json,L"date_to",L"2021-03-30");
CkJsonObjectW_UpdateString(json,L"link",L"2ccd5e15-194a-4a19-a45a-e7223c7e6717");
CkJsonObjectW_UpdateString(json,L"token",L"1234ab");
CkJsonObjectW_UpdateBool(json,L"save_data",TRUE);
CkJsonObjectW_UpdateString(json,L"account",L"d4617561-1c01-4b2f-83b6-a594f7b3bc57");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
resp = CkHttpW_PostJson3(http,L"https://domain.com/api/balances/",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jarrResp = CkJsonArrayW_Create();
CkJsonArrayW_LoadSb(jarrResp,sbResponseBody);
CkJsonArrayW_putEmitCompact(jarrResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonArrayW_emit(jarrResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonArrayW_Dispose(jarrResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "id": "<uuid>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "category": "eu exercitation id ullamco",
// "currency": "<string>"
// },
// "collected_at": "<dateTime>",
// "value_date": "<date>",
// "balance": "<number>",
// "current_balance": "<number>",
// "statement": "<string>"
// },
// {
// "id": "<uuid>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "category": "eu tempor adipisicing",
// "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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonArrayW_getSize(jarrResp);
while (i < count_i) {
json = CkJsonArrayW_ObjectAt(jarrResp,i);
id = CkJsonObjectW_stringOf(json,L"id");
Id = CkJsonObjectW_stringOf(json,L"account.id");
Name = CkJsonObjectW_stringOf(json,L"account.name");
Category = CkJsonObjectW_stringOf(json,L"account.category");
v_Currency = CkJsonObjectW_stringOf(json,L"account.currency");
collected_at = CkJsonObjectW_stringOf(json,L"collected_at");
value_date = CkJsonObjectW_stringOf(json,L"value_date");
balance = CkJsonObjectW_stringOf(json,L"balance");
current_balance = CkJsonObjectW_stringOf(json,L"current_balance");
statement = CkJsonObjectW_stringOf(json,L"statement");
CkJsonObjectW_Dispose(json);
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonArrayW_Dispose(jarrResp);
}
Curl Command
curl -X POST
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"date_from": "2021-01-01",
"date_to": "2021-03-30",
"link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
"token": "1234ab",
"save_data": true,
"account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
}'
https://domain.com/api/balances/
Postman Collection Item JSON
{
"name": "Retrieve",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"2021-01-01\",\n \"date_to\": \"2021-03-30\",\n \"link\": \"2ccd5e15-194a-4a19-a45a-e7223c7e6717\",\n \"token\": \"1234ab\",\n \"save_data\": true,\n \"account\": \"d4617561-1c01-4b2f-83b6-a594f7b3bc57\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances",
""
]
},
"description": "Retrieve balances from one or more accounts for a specific link within a specified date range."
},
"response": [
{
"name": "Ok (when save_data=false)",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu exercitation id ullamco\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu tempor adipisicing\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t}\n]"
},
{
"name": "Created (when save_data=true)",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu exercitation id ullamco\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu tempor adipisicing\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t}\n]"
},
{
"name": "Bad request error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Bad Request",
"code": 400,
"_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]"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"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]"
},
{
"name": "Request Timeout",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Request Timeout",
"code": 408,
"_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]"
},
{
"name": "MFA Token Required",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Precondition Required",
"code": 428,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"code\": \"<string>\",\n\t\"message\": \"<string>\",\n\t\"request_id\": \"<uuid>\",\n\t\"session\": \"<uuid>\",\n\t\"expiry\": \"<integer>\",\n\t\"link\": \"<uuid>\",\n\t\"token_generation_data\": {\n\t\t\"instructions\": \"<string>\",\n\t\t\"type\": \"<string>\",\n\t\t\"value\": \"<string>\"\n\t}\n}"
},
{
"name": "Unexpected Error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_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]"
}
]
}