Chilkat Online Tools

Swift3 / Belvo API Docs / List

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "{{secretId}}"
    http.password = "{{secretPassword}}"

    let queryParams = CkoJsonObject()!
    queryParams.updateInt("page", value: 1)

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://domain.com/api/links/", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var id: String?
    var institution: String?
    var access_mode: String?
    var last_accessed_at: String?
    var status: String?
    var created_by: String?
    var refresh_rate: String?

    var count: String? = jResp.string(of: "count")
    var v_next: String? = jResp.string(of: "next")
    var previous: String? = jResp.string(of: "previous")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "results").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "results[i].id")
        institution = jResp.string(of: "results[i].institution")
        access_mode = jResp.string(of: "results[i].access_mode")
        last_accessed_at = jResp.string(of: "results[i].last_accessed_at")
        status = jResp.string(of: "results[i].status")
        created_by = jResp.string(of: "results[i].created_by")
        refresh_rate = jResp.string(of: "results[i].refresh_rate")
        i = i + 1
    }


}

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]"
    }
  ]
}