Chilkat Online Tools

delphiDll / Belvo API Docs / List

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
collected_at: PWideChar;
Id: PWideChar;
Name: PWideChar;
v_Currency: PWideChar;
Category: PWideChar;
v_currency: PWideChar;
j: Integer;
count_j: Integer;
confidence: PWideChar;
v_type: PWideChar;
k: Integer;
count_k: Integer;
value: PWideChar;
count: PWideChar;
v_next: PWideChar;
previous: PWideChar;
i: Integer;
count_i: Integer;

begin
// 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) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

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 do
  begin
    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 do
      begin
        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 do
          begin
            CkJsonObject_putK(jResp,k);
            value := CkJsonObject__stringOf(jResp,'results[i].sources[j].transactions[k].value');
            k := k + 1;
          end;

        j := j + 1;
      end;

    i := i + 1;
  end;

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]"
    }
  ]
}