Chilkat Online Tools

phpExt / Belvo API Docs / Detail

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

$http->put_BasicAuth(true);
$http->put_Login('{{secretId}}');
$http->put_Password('{{secretPassword}}');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://domain.com/api/incomes/:id/',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jarrResp = new CkJsonArray();
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jarrResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

// [
//   {
//     "id": "<uuid>",
//     "collected_at": "<dateTime>",
//     "account": {
//       "name": "<string>",
//       "currency": "<string>",
//       "category": "adipisicing pariatur sit"
//     },
//     "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": {
//       "name": "<string>",
//       "currency": "<string>",
//       "category": "exercitation consequat"
//     },
//     "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

$i = 0;
$count_i = $jarrResp->get_Size();
while ($i < $count_i) {
    // json is a CkJsonObject
    $json = $jarrResp->ObjectAt($i);
    $id = $json->stringOf('id');
    $collected_at = $json->stringOf('collected_at');
    $Name = $json->stringOf('account.name');
    $v_Currency = $json->stringOf('account.currency');
    $Category = $json->stringOf('account.category');
    $v_currency = $json->stringOf('currency');
    $j = 0;
    $count_j = $json->SizeOfArray('sources');
    while ($j < $count_j) {
        $json->put_J($j);
        $confidence = $json->stringOf('sources[j].confidence');
        $v_type = $json->stringOf('sources[j].type');
        $k = 0;
        $count_k = $json->SizeOfArray('sources[j].transactions');
        while ($k < $count_k) {
            $json->put_K($k);
            $value = $json->stringOf('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/:id/

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/incomes/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "incomes",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `income.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific income."
  },
  "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "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\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"adipisicing pariatur sit\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"exercitation consequat\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "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": "Too Many Sessions",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/incomes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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]"
    }
  ]
}