Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonArray.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonArray jarrResp;
int respStatusCode;
HCkJsonObject json;
const char *id;
const char *link;
const char *collected_at;
const char *informacion_general;
const char *sueldos_salarios;
const char *servicios_profesionales;
const char *deducciones_personales;
const char *determinacion_impuesto;
const char *retenciones;
const char *dividendos;
const char *datos_informativos;
const char *pdf;
int i;
int count_i;
// 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/tax-returns/",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jarrResp = CkJsonArray_Create();
CkJsonArray_LoadSb(jarrResp,sbResponseBody);
CkJsonArray_putEmitCompact(jarrResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonArray_emit(jarrResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonArray_Dispose(jarrResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "id": "<uuid>",
// "link": "<uuid>",
// "collected_at": "<dateTime>",
// "informacion_general": "<object>",
// "sueldos_salarios": "<object>",
// "servicios_profesionales": "<object>",
// "deducciones_personales": "<object>",
// "determinacion_impuesto": "<object>",
// "retenciones": "<object>",
// "dividendos": "<object>",
// "datos_informativos": "<object>",
// "pdf": "<binary>"
// },
// {
// "id": "<uuid>",
// "link": "<uuid>",
// "collected_at": "<dateTime>",
// "informacion_general": "<object>",
// "sueldos_salarios": "<object>",
// "servicios_profesionales": "<object>",
// "deducciones_personales": "<object>",
// "determinacion_impuesto": "<object>",
// "retenciones": "<object>",
// "dividendos": "<object>",
// "datos_informativos": "<object>",
// "pdf": "<binary>"
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonArray_getSize(jarrResp);
while (i < count_i) {
json = CkJsonArray_ObjectAt(jarrResp,i);
id = CkJsonObject_stringOf(json,"id");
link = CkJsonObject_stringOf(json,"link");
collected_at = CkJsonObject_stringOf(json,"collected_at");
informacion_general = CkJsonObject_stringOf(json,"informacion_general");
sueldos_salarios = CkJsonObject_stringOf(json,"sueldos_salarios");
servicios_profesionales = CkJsonObject_stringOf(json,"servicios_profesionales");
deducciones_personales = CkJsonObject_stringOf(json,"deducciones_personales");
determinacion_impuesto = CkJsonObject_stringOf(json,"determinacion_impuesto");
retenciones = CkJsonObject_stringOf(json,"retenciones");
dividendos = CkJsonObject_stringOf(json,"dividendos");
datos_informativos = CkJsonObject_stringOf(json,"datos_informativos");
pdf = CkJsonObject_stringOf(json,"pdf");
CkJsonObject_Dispose(json);
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonArray_Dispose(jarrResp);
}
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/tax-returns/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/tax-returns/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-returns",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set.",
"disabled": true
}
]
},
"description": "Get a paginated list of all existing tax returns in your Belvo account. We return up to 100 results per page.\n\nThe results will include a mix of both monthly and yearly tax returns."
},
"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/tax-returns?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-returns"
],
"query": [
{
"key": "page",
"value": "<integer>"
}
]
}
},
"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\"link\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"informacion_general\": \"<object>\",\n\t\t\"sueldos_salarios\": \"<object>\",\n\t\t\"servicios_profesionales\": \"<object>\",\n\t\t\"deducciones_personales\": \"<object>\",\n\t\t\"determinacion_impuesto\": \"<object>\",\n\t\t\"retenciones\": \"<object>\",\n\t\t\"dividendos\": \"<object>\",\n\t\t\"datos_informativos\": \"<object>\",\n\t\t\"pdf\": \"<binary>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"informacion_general\": \"<object>\",\n\t\t\"sueldos_salarios\": \"<object>\",\n\t\t\"servicios_profesionales\": \"<object>\",\n\t\t\"deducciones_personales\": \"<object>\",\n\t\t\"determinacion_impuesto\": \"<object>\",\n\t\t\"retenciones\": \"<object>\",\n\t\t\"dividendos\": \"<object>\",\n\t\t\"datos_informativos\": \"<object>\",\n\t\t\"pdf\": \"<binary>\"\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/tax-returns?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-returns"
],
"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]"
}
]
}
