Back to Collection Items
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"{{secretId}}";
http.Password = @"{{secretPassword}}";
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://domain.com/api/incomes/" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"Failed.");
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
NSString *id = 0;
NSString *collected_at = 0;
NSString *Id = 0;
NSString *Name = 0;
NSString *v_Currency = 0;
NSString *Category = 0;
NSString *v_currency = 0;
int j;
int count_j;
NSString *confidence = 0;
NSString *v_type = 0;
int k;
int count_k;
NSString *value = 0;
NSString *count = [jResp StringOf: @"count"];
NSString *v_next = [jResp StringOf: @"next"];
NSString *previous = [jResp StringOf: @"previous"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"results"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
id = [jResp StringOf: @"results[i].id"];
collected_at = [jResp StringOf: @"results[i].collected_at"];
Id = [jResp StringOf: @"results[i].account.id"];
Name = [jResp StringOf: @"results[i].account.name"];
v_Currency = [jResp StringOf: @"results[i].account.currency"];
Category = [jResp StringOf: @"results[i].account.category"];
v_currency = [jResp StringOf: @"results[i].currency"];
j = 0;
count_j = [[jResp SizeOfArray: @"results[i].sources"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
confidence = [jResp StringOf: @"results[i].sources[j].confidence"];
v_type = [jResp StringOf: @"results[i].sources[j].type"];
k = 0;
count_k = [[jResp SizeOfArray: @"results[i].sources[j].transactions"] intValue];
while (k < count_k) {
jResp.K = [NSNumber numberWithInt: k];
value = [jResp StringOf: @"results[i].sources[j].transactions[k].value"];
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
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]"
}
]
}
