Chilkat Tools

delphiDll / Belvo API Docs / List

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
link: PWideChar;
collected_at: PWideChar;
display_name: PWideChar;
first_name: PWideChar;
last_name: PWideChar;
second_last_name: PWideChar;
address: PWideChar;
email: PWideChar;
phone_number: PWideChar;
Collected_at: PWideChar;
Status: PWideChar;
Acceptance_rate: PWideChar;
j: Integer;
count_j: 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}}');

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateInt(queryParams,'page',1);

resp := CkHttp_QuickRequestParams(http,'GET','https://domain.com/api/owners/',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

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

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

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "count": "<integer>",
//   "next": "<string>",
//   "previous": "<string>",
//   "results": [
//     {
//       "id": "<uuid>",
//       "link": "<uuid>",
//       "collected_at": "<dateTime>",
//       "display_name": "<string>",
//       "first_name": "<string>",
//       "last_name": "<string>",
//       "second_last_name": "<string>",
//       "address": "<string>",
//       "email": "<email>",
//       "phone_number": "<string>",
//       "accounts": [
//         {
//           "value": "<Error: Too many levels of nesting to fake this schema>"
//         },
//         {
//           "value": "<Error: Too many levels of nesting to fake this schema>"
//         }
//       ],
//       "gig_data": {
//         "collected_at": "<dateTime>",
//         "status": "<string>",
//         "acceptance_rate": "<number>"
//       }
//     },
//     {
//       "id": "<uuid>",
//       "link": "<uuid>",
//       "collected_at": "<dateTime>",
//       "display_name": "<string>",
//       "first_name": "<string>",
//       "last_name": "<string>",
//       "second_last_name": "<string>",
//       "address": "<string>",
//       "email": "<email>",
//       "phone_number": "<string>",
//       "accounts": [
//         {
//           "value": "<Error: Too many levels of nesting to fake this schema>"
//         },
//         {
//           "value": "<Error: Too many levels of nesting to fake this schema>"
//         }
//       ],
//       "gig_data": {
//         "collected_at": "<dateTime>",
//         "status": "<string>",
//         "acceptance_rate": "<number>"
//       }
//     }
//   ]
// }

// 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');
    link := CkJsonObject__stringOf(jResp,'results[i].link');
    collected_at := CkJsonObject__stringOf(jResp,'results[i].collected_at');
    display_name := CkJsonObject__stringOf(jResp,'results[i].display_name');
    first_name := CkJsonObject__stringOf(jResp,'results[i].first_name');
    last_name := CkJsonObject__stringOf(jResp,'results[i].last_name');
    second_last_name := CkJsonObject__stringOf(jResp,'results[i].second_last_name');
    address := CkJsonObject__stringOf(jResp,'results[i].address');
    email := CkJsonObject__stringOf(jResp,'results[i].email');
    phone_number := CkJsonObject__stringOf(jResp,'results[i].phone_number');
    Collected_at := CkJsonObject__stringOf(jResp,'results[i].gig_data.collected_at');
    Status := CkJsonObject__stringOf(jResp,'results[i].gig_data.status');
    Acceptance_rate := CkJsonObject__stringOf(jResp,'results[i].gig_data.acceptance_rate');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'results[i].accounts');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        value := CkJsonObject__stringOf(jResp,'results[i].accounts[j].value');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -G -d "page=1"
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/owners/

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/owners/?page=1",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "owners",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set."
        }
      ]
    },
    "description": "Get a paginated list of all existing owners 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/owners?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "owners"
          ],
          "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\"link\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"first_name\": \"<string>\",\n\t\t\t\"last_name\": \"<string>\",\n\t\t\t\"second_last_name\": \"<string>\",\n\t\t\t\"address\": \"<string>\",\n\t\t\t\"email\": \"<email>\",\n\t\t\t\"phone_number\": \"<string>\",\n\t\t\t\"accounts\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"gig_data\": {\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"status\": \"<string>\",\n\t\t\t\t\"acceptance_rate\": \"<number>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"link\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"first_name\": \"<string>\",\n\t\t\t\"last_name\": \"<string>\",\n\t\t\t\"second_last_name\": \"<string>\",\n\t\t\t\"address\": \"<string>\",\n\t\t\t\"email\": \"<email>\",\n\t\t\t\"phone_number\": \"<string>\",\n\t\t\t\"accounts\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"gig_data\": {\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"status\": \"<string>\",\n\t\t\t\t\"acceptance_rate\": \"<number>\"\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/owners?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "owners"
          ],
          "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]"
    }
  ]
}

Chilkat Online Tools

delphiDll / Belvo API Docs / List

Curl Command

Postman Collection Item JSON