Chilkat Online Tools

Powershell / Sunshine Conversations API / List App Keys

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "username"
$http.Password = "password"

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://domain.com/",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    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

$i = 0
$count_i = $jResp.SizeOfArray("keys")
while ($i -lt $count_i) {
    $jResp.I = $i
    $id = $jResp.StringOf("keys[i].id")
    $displayName = $jResp.StringOf("keys[i].displayName")
    $secret = $jResp.StringOf("keys[i].secret")
    $i = $i + 1
}

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