Chilkat Online Tools

phpExt / Sunshine Conversations API / Get Integration Key

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

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

$http = new CkHttp();

$http->put_BasicAuth(true);
$http->put_Login('username');
$http->put_Password('password');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/keys/:keyId',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

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

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

// {
//   "key": {
//     "id": "int_5e4b0f225aca01092928f917",
//     "displayName": "Duis",
//     "secret": "Ck1LjzzlUzvlCTtqAdQ2z1QukuBTrN3TIx"
//   }
// }

// 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}}/integrations/:integrationId/keys/:keyId

Postman Collection Item JSON

{
  "name": "Get Integration Key",
  "_postman_id": "45facd5d-2a35-4f6d-971b-5100c8020ce0",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/integrations/:integrationId/keys/:keyId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "integrations",
        ":integrationId",
        "keys",
        ":keyId"
      ],
      "variable": [
        {
          "key": "integrationId"
        },
        {
          "key": "keyId"
        }
      ]
    },
    "description": "Get the specified API key."
  },
  "response": [
    {
      "id": "30e032ff-1e7b-4d98-be4f-3cc59a86e312",
      "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/integrations/:integrationId/keys/:keyId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId",
            "keys",
            ":keyId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            },
            {
              "key": "keyId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"key\": {\n  \"id\": \"int_5e4b0f225aca01092928f917\",\n  \"displayName\": \"Duis\",\n  \"secret\": \"Ck1LjzzlUzvlCTtqAdQ2z1QukuBTrN3TIx\"\n }\n}"
    }
  ]
}