Chilkat Online Tools

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "username"
loHttp.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"
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("displayName","inci")

loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.PostJson3("https://domain.com/","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

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

lcId = loJResp.StringOf("key.id")
lcDisplayName = loJResp.StringOf("key.displayName")
lcSecret = loJResp.StringOf("key.secret")


release loHttp
release loJson
release loSbResponseBody
release loJResp

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}"
    }
  ]
}