Chilkat Online Tools

Python / Sunshine Conversations API / Create Integration

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

http.put_BasicAuth(True)
http.put_Login("username")
http.put_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.

# {
#   "type": "android",
#   "status": "inactive",
#   "displayName": "Channel name"
# }

json = chilkat.CkJsonObject()
json.UpdateString("type","android")
json.UpdateString("status","inactive")
json.UpdateString("displayName","Channel name")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/","application/json",json)
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.header())
    print("Failed.")

    sys.exit()

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

# {
#   "integration": {
#     "id": "5e4af71a81966cfff3ef6550",
#     "type": "android",
#     "status": "active",
#     "displayName": "Android",
#     "serverId": "<sender-id>",
#     "canUserCreateMoreConversations": true
#   }
# }

# 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("integration.id")
v_Type = jResp.stringOf("integration.type")
Status = jResp.stringOf("integration.status")
DisplayName = jResp.stringOf("integration.displayName")
ServerId = jResp.stringOf("integration.serverId")
CanUserCreateMoreConversations = jResp.BoolOf("integration.canUserCreateMoreConversations")

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "type": "android",
    "status": "inactive",
    "displayName": "Channel name"
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Create Integration",
  "_postman_id": "80a66b25-9cd7-45fd-9797-078819996d0d",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"type\": \"android\",\n    \"status\": \"inactive\",\n    \"displayName\": \"Channel name\"\n}"
    },
    "url": "{{url}}/v2/apps/{{appId}}/integrations",
    "description": "The Create Integration endpoint allows you to provision apps with front-end messaging channels. Selecting a `custom` integration allows the creation of webhooks."
  },
  "response": [
    {
      "id": "423dee8e-37bd-4c2a-9372-cd614554ff0e",
      "name": "Invalid integration type",
      "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    \"type\": \"android\",\n    \"status\": \"inactive\",\n    \"displayName\": \"Channel name\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/integrations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "5268f4cc-51fa-4a3c-83f3-b496702386c6",
      "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    \"type\": \"android\",\n    \"status\": \"inactive\",\n    \"displayName\": \"Channel name\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/integrations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"integration\": {\n  \"id\": \"5e4af71a81966cfff3ef6550\",\n  \"type\": \"android\",\n  \"status\": \"active\",\n  \"displayName\": \"Android\",\n  \"serverId\": \"<sender-id>\",\n  \"canUserCreateMoreConversations\": true\n }\n}"
    }
  ]
}