Chilkat Online Tools

C++ / Sunshine Conversations API / List App Keys

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login("username");
    http.put_Password("password");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://domain.com/",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *id = 0;
    const char *displayName = 0;
    const char *secret = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray("keys");
    while (i < count_i) {
        jResp.put_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}"
    }
  ]
}