Chilkat Online Tools

C++ / Sunshine Conversations API / Get App

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)

    // {
    //   "app": {
    //     "id": "5d8cff3cd55b040010928b5b",
    //     "displayName": "utoc",
    //     "settings": {
    //       "conversationRetentionSeconds": 35855812,
    //       "maskCreditCardNumbers": true,
    //       "useAnimalNames": false,
    //       "echoPostback": true,
    //       "ignoreAutoConversationStart": true,
    //       "multiConvoEnabled": true,
    //       "attachmentsAccess": "public",
    //       "attachmentsTokenExpirationSeconds": 64028
    //     },
    //     "metadata": {
    //       "lang": "en-ca"
    //     }
    //   }
    // }

    // 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 = jResp.stringOf("app.id");
    const char *DisplayName = jResp.stringOf("app.displayName");
    int ConversationRetentionSeconds = jResp.IntOf("app.settings.conversationRetentionSeconds");
    bool MaskCreditCardNumbers = jResp.BoolOf("app.settings.maskCreditCardNumbers");
    bool UseAnimalNames = jResp.BoolOf("app.settings.useAnimalNames");
    bool EchoPostback = jResp.BoolOf("app.settings.echoPostback");
    bool IgnoreAutoConversationStart = jResp.BoolOf("app.settings.ignoreAutoConversationStart");
    bool MultiConvoEnabled = jResp.BoolOf("app.settings.multiConvoEnabled");
    const char *AttachmentsAccess = jResp.stringOf("app.settings.attachmentsAccess");
    int AttachmentsTokenExpirationSeconds = jResp.IntOf("app.settings.attachmentsTokenExpirationSeconds");
    const char *Lang = jResp.stringOf("app.metadata.lang");
    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get App",
  "_postman_id": "b6b38388-b3be-454f-aca6-f0624470ea02",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": "{{url}}/v2/apps/{{appId}}",
    "description": "Fetches an individual app."
  },
  "response": [
    {
      "id": "12c94751-e245-4540-8c81-865dccad09d5",
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"app\": {\n  \"id\": \"5d8cff3cd55b040010928b5b\",\n  \"displayName\": \"utoc\",\n  \"settings\": {\n   \"conversationRetentionSeconds\": 35855812,\n   \"maskCreditCardNumbers\": true,\n   \"useAnimalNames\": false,\n   \"echoPostback\": true,\n   \"ignoreAutoConversationStart\": true,\n   \"multiConvoEnabled\": true,\n   \"attachmentsAccess\": \"public\",\n   \"attachmentsTokenExpirationSeconds\": 64028\n  },\n  \"metadata\": {\n   \"lang\": \"en-ca\"\n  }\n }\n}"
    },
    {
      "id": "8aa1f69d-ba23-420b-ae3f-870557fcf2ce",
      "name": "App not found",
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}