Chilkat Online Tools

Xojo / Sunshine Conversations API / Get Integration Key

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "username"
http.Password = "password"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/keys/:keyId",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

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

Dim Id As String
Id = jResp.StringOf("key.id")
Dim DisplayName As String
DisplayName = jResp.StringOf("key.displayName")
Dim Secret As String
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}"
    }
  ]
}