Chilkat Online Tools

phpAx / Sunshine Conversations API / Create App Key

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$http->Login = 'username';
$http->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"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('displayName','inci');

$http->SetRequestHeader('Content-Type','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

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