Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcInstitution
LOCAL lcAccess_mode
LOCAL lcLast_accessed_at
LOCAL lcStatus
LOCAL lcCreated_by
LOCAL lcRefresh_rate
LOCAL lcCount
LOCAL lcV_next
LOCAL lcPrevious
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "{{secretId}}"
loHttp.Password = "{{secretPassword}}"
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateInt("page",1)
loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpParams("GET","https://domain.com/api/links/",loQueryParams,loResp)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
RELEASE loResp
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loHttp
RELEASE loQueryParams
RELEASE loResp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "count": "<integer>",
* "next": "<string>",
* "previous": "<string>",
* "results": [
* {
* "id": "<uuid>",
* "institution": "<string>",
* "access_mode": "<string>",
* "last_accessed_at": "<dateTime>",
* "status": "<string>",
* "created_by": "<uuid>",
* "refresh_rate": "<string>"
* },
* {
* "id": "<uuid>",
* "institution": "<string>",
* "access_mode": "<string>",
* "last_accessed_at": "<dateTime>",
* "status": "<string>",
* "created_by": "<uuid>",
* "refresh_rate": "<string>"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcCount = loJResp.StringOf("count")
lcV_next = loJResp.StringOf("next")
lcPrevious = loJResp.StringOf("previous")
i = 0
lnCount_i = loJResp.SizeOfArray("results")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("results[i].id")
lcInstitution = loJResp.StringOf("results[i].institution")
lcAccess_mode = loJResp.StringOf("results[i].access_mode")
lcLast_accessed_at = loJResp.StringOf("results[i].last_accessed_at")
lcStatus = loJResp.StringOf("results[i].status")
lcCreated_by = loJResp.StringOf("results[i].created_by")
lcRefresh_rate = loJResp.StringOf("results[i].refresh_rate")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loResp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -G -d "page=1"
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/links/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/links/?page=1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set."
}
]
},
"description": "Get a paginated list of all the existing links 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/links?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links"
],
"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\"institution\": \"<string>\",\n\t\t\t\"access_mode\": \"<string>\",\n\t\t\t\"last_accessed_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"created_by\": \"<uuid>\",\n\t\t\t\"refresh_rate\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"institution\": \"<string>\",\n\t\t\t\"access_mode\": \"<string>\",\n\t\t\t\"last_accessed_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"created_by\": \"<uuid>\",\n\t\t\t\"refresh_rate\": \"<string>\"\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/links?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"links"
],
"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]"
}
]
}
