Chilkat Online Tools

TCL / Sunshine Conversations API / List App Keys

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $http "password"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "keys": [
#     {
#       "id": "app_5723a347f82ba0516cb4ea34",
#       "displayName": "Key 1",
#       "secret": "5XJ85yjUtRcaQu_pDINblPZb"
#     },
#     {
#       "id": "app_5723a347f82ba0516cb4ea34",
#       "displayName": "Key 1",
#       "secret": "5XJ85yjUtRcaQu_pDINblPZb"
#     }
#   ]
# }

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

set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "keys"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set id [CkJsonObject_stringOf $jResp "keys[i].id"]
    set displayName [CkJsonObject_stringOf $jResp "keys[i].displayName"]
    set secret [CkJsonObject_stringOf $jResp "keys[i].secret"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-u 'username:password'
https://domain.com/

Postman Collection Item JSON

{
  "name": "List App Keys",
  "_postman_id": "b281ea4d-3b8d-4ace-8cea-ac98cd6aeb96",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": "{{url}}/v2/apps/{{appId}}/keys",
    "description": "Lists all API keys for a given app."
  },
  "response": [
    {
      "id": "9e381369-82a7-48be-a1e4-4c9cda88af3c",
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/keys",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "keys"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"keys\": [\n  {\n   \"id\": \"app_5723a347f82ba0516cb4ea34\",\n   \"displayName\": \"Key 1\",\n   \"secret\": \"5XJ85yjUtRcaQu_pDINblPZb\"\n  },\n  {\n   \"id\": \"app_5723a347f82ba0516cb4ea34\",\n   \"displayName\": \"Key 1\",\n   \"secret\": \"5XJ85yjUtRcaQu_pDINblPZb\"\n  }\n ]\n}"
    }
  ]
}