Chilkat Online Tools

autoit / Sunshine Conversations API / Get App Key

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "username"
$oHttp.Password = "password"

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/v2/apps/{{appId}}/keys/:keyId",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $sId = $oJResp.StringOf("key.id")
Local $sDisplayName = $oJResp.StringOf("key.displayName")
Local $sSecret = $oJResp.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": ""
    }
  ]
}