Chilkat Online Tools

Ruby / Sunshine Conversations API / Get App Key

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/v2/apps/{{appId}}/keys/:keyId",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "key": {
#     "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

Id = jResp.stringOf("key.id")
DisplayName = jResp.stringOf("key.displayName")
Secret = jResp.stringOf("key.secret")

Curl Command

curl -X GET
	-u 'username:password'
https://domain.com/v2/apps/{{appId}}/keys/:keyId

Postman Collection Item JSON

{
  "name": "Get App Key",
  "_postman_id": "b0b5c2d8-b732-4139-a4f9-a09cca62987b",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/keys/:keyId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "keys",
        ":keyId"
      ],
      "variable": [
        {
          "key": "keyId"
        }
      ]
    },
    "description": "Returns an API key."
  },
  "response": [
    {
      "id": "552c67a9-4f47-49f0-ab94-a85d632226c8",
      "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/:keyId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "keys",
            ":keyId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "keyId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"key\": {\n  \"id\": \"app_5723a347f82ba0516cb4ea34\",\n  \"displayName\": \"Key 1\",\n  \"secret\": \"5XJ85yjUtRcaQu_pDINblPZb\"\n }\n}"
    },
    {
      "id": "730d9747-324f-42cb-9357-48c0e765b588",
      "name": "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/keys/:keyId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "keys",
            ":keyId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "keyId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}