Chilkat Online Tools

autoit / Sunshine Conversations API / Create 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.Http")
Local $bSuccess

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

; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

; The following JSON is sent in the request body.

; {
;   "displayName": "inci"
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("displayName","inci")

$oHttp.SetRequestHeader "Content-Type","application/json"

$oResp = ObjCreate("Chilkat.HttpResponse")
$bSuccess = $oHttp.HttpJson("POST","https://domain.com/",$oJson,"application/json",$oResp)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

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

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

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @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 POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "displayName": "inci"
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Create App Key",
  "_postman_id": "9473fd64-8325-4f31-84dc-df2f307baf08",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"displayName\": \"inci\"\n}"
    },
    "url": "{{url}}/v2/apps/{{appId}}/keys",
    "description": "Creates an API key for the specified app. The response body will include a secret \nas well as its corresponding id, which you can use to generate JSON Web Tokens to \nsecurely make API calls on behalf of the app.\n"
  },
  "response": [
    {
      "id": "02e812c8-8c06-4ee5-b580-926c898edd32",
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"displayName\": \"inci\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/keys",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "keys"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_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}"
    }
  ]
}