Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *id;
const char *collected_at;
const char *Id;
const char *Name;
const char *v_Currency;
const char *Category;
const char *v_currency;
int j;
int count_j;
const char *confidence;
const char *v_type;
int k;
int count_k;
const char *value;
const char *count;
const char *v_next;
const char *previous;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"{{secretId}}");
CkHttp_putPassword(http,"{{secretPassword}}");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://domain.com/api/incomes/",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "next": "<string>",
// "previous": "<string>",
// "results": [
// {
// "id": "<uuid>",
// "collected_at": "<dateTime>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "currency": "<string>",
// "category": "aliquip Lorem cupidatat dolore"
// },
// "currency": "<string>",
// "sources": [
// {
// "transactions": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "confidence": "<string>",
// "type": "<string>"
// },
// {
// "transactions": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "confidence": "<string>",
// "type": "<string>"
// }
// ]
// },
// {
// "id": "<uuid>",
// "collected_at": "<dateTime>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "currency": "<string>",
// "category": "nisi est"
// },
// "currency": "<string>",
// "sources": [
// {
// "transactions": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "confidence": "<string>",
// "type": "<string>"
// },
// {
// "transactions": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "confidence": "<string>",
// "type": "<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.
count = CkJsonObject_stringOf(jResp,"count");
v_next = CkJsonObject_stringOf(jResp,"next");
previous = CkJsonObject_stringOf(jResp,"previous");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"results");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
id = CkJsonObject_stringOf(jResp,"results[i].id");
collected_at = CkJsonObject_stringOf(jResp,"results[i].collected_at");
Id = CkJsonObject_stringOf(jResp,"results[i].account.id");
Name = CkJsonObject_stringOf(jResp,"results[i].account.name");
v_Currency = CkJsonObject_stringOf(jResp,"results[i].account.currency");
Category = CkJsonObject_stringOf(jResp,"results[i].account.category");
v_currency = CkJsonObject_stringOf(jResp,"results[i].currency");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"results[i].sources");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
confidence = CkJsonObject_stringOf(jResp,"results[i].sources[j].confidence");
v_type = CkJsonObject_stringOf(jResp,"results[i].sources[j].type");
k = 0;
count_k = CkJsonObject_SizeOfArray(jResp,"results[i].sources[j].transactions");
while (k < count_k) {
CkJsonObject_putK(jResp,k);
value = CkJsonObject_stringOf(jResp,"results[i].sources[j].transactions[k].value");
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/incomes/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/incomes/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"incomes",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set.",
"disabled": true
}
]
},
"description": "Get a paginated list of all incomes 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/incomes?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"incomes"
],
"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\"collected_at\": \"<dateTime>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\"category\": \"aliquip Lorem cupidatat dolore\"\n\t\t\t},\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"sources\": [\n\t\t\t\t{\n\t\t\t\t\t\"transactions\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\t\"type\": \"<string>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"transactions\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\t\"type\": \"<string>\"\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"currency\": \"<string>\",\n\t\t\t\t\"category\": \"nisi est\"\n\t\t\t},\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"sources\": [\n\t\t\t\t{\n\t\t\t\t\t\"transactions\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\t\"type\": \"<string>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"transactions\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\t\"type\": \"<string>\"\n\t\t\t\t}\n\t\t\t]\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/incomes?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"incomes"
],
"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]"
}
]
}