Chilkat Online Tools

VB.NET / Sunshine Conversations API / List Integration Keys

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",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


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

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


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

' {
'   "keys": [
'     {
'       "id": "int_5e4b0f225aca01092928f917",
'       "displayName": "cupi",
'       "secret": "Ck1LjzzlUzvlCTtqAdQ2z1QukuBTrN3TIx"
'     },
'     {
'       "id": "int_5e4b0f225aca01092928f917",
'       "displayName": "moll",
'       "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
Dim displayName As String
Dim secret As String

Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("keys")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("keys[i].id")
    displayName = jResp.StringOf("keys[i].displayName")
    secret = jResp.StringOf("keys[i].secret")
    i = i + 1
End While

Curl Command

curl -X GET
	-u 'username:password'
https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/keys

Postman Collection Item JSON

{
  "name": "List Integration Keys",
  "_postman_id": "8096a97b-d9f8-4618-b152-f3f814743c6a",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/integrations/:integrationId/keys",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "integrations",
        ":integrationId",
        "keys"
      ],
      "variable": [
        {
          "key": "integrationId"
        }
      ]
    },
    "description": "Lists all API keys for a given integration."
  },
  "response": [
    {
      "id": "19ca2281-8e97-46b8-bd64-ff0bb116b992",
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId",
            "keys"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"keys\": [\n  {\n   \"id\": \"int_5e4b0f225aca01092928f917\",\n   \"displayName\": \"cupi\",\n   \"secret\": \"Ck1LjzzlUzvlCTtqAdQ2z1QukuBTrN3TIx\"\n  },\n  {\n   \"id\": \"int_5e4b0f225aca01092928f917\",\n   \"displayName\": \"moll\",\n   \"secret\": \"Ck1LjzzlUzvlCTtqAdQ2z1QukuBTrN3TIx\"\n  }\n ]\n}"
    },
    {
      "id": "99bae7e3-0698-4f12-827b-740072a5dec1",
      "name": "API keys are available only for custom integrations",
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId",
            "keys"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}