Chilkat Online Tools

Objective-C / Belvo API Docs / Detail

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/accounts/:id/" 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)

// {
//   "id": "<uuid>",
//   "link": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "institution": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "collected_at": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "category": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "type": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "name": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "number": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "balance": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "currency": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "bank_product_id": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "internal_identification": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "public_identification_name": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "public_identification_value": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "last_accessed_at": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "credit_data": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "loan_data": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "funds_data": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   },
//   "gig_payment_data": {
//     "value": "<Error: Too many levels of nesting to fake this schema>"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *id = [jResp StringOf: @"id"];
NSString *Value = [jResp StringOf: @"link.value"];
NSString *institutionValue = [jResp StringOf: @"institution.value"];
NSString *collected_atValue = [jResp StringOf: @"collected_at.value"];
NSString *categoryValue = [jResp StringOf: @"category.value"];
NSString *typeValue = [jResp StringOf: @"type.value"];
NSString *nameValue = [jResp StringOf: @"name.value"];
NSString *numberValue = [jResp StringOf: @"number.value"];
NSString *balanceValue = [jResp StringOf: @"balance.value"];
NSString *currencyValue = [jResp StringOf: @"currency.value"];
NSString *bank_product_idValue = [jResp StringOf: @"bank_product_id.value"];
NSString *internal_identificationValue = [jResp StringOf: @"internal_identification.value"];
NSString *public_identification_nameValue = [jResp StringOf: @"public_identification_name.value"];
NSString *public_identification_valueValue = [jResp StringOf: @"public_identification_value.value"];
NSString *last_accessed_atValue = [jResp StringOf: @"last_accessed_at.value"];
NSString *credit_dataValue = [jResp StringOf: @"credit_data.value"];
NSString *loan_dataValue = [jResp StringOf: @"loan_data.value"];
NSString *funds_dataValue = [jResp StringOf: @"funds_data.value"];
NSString *gig_payment_dataValue = [jResp StringOf: @"gig_payment_data.value"];

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/accounts/:id/

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/accounts/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "accounts",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `account.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific account."
  },
  "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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"institution\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"collected_at\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"category\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"type\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"name\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"number\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"balance\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"currency\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"bank_product_id\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"internal_identification\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"public_identification_name\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"public_identification_value\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"last_accessed_at\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"credit_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"loan_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"funds_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t},\n\t\"gig_payment_data\": {\n\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":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/accounts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "accounts",
            ":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]"
    }
  ]
}