Chilkat Online Tools

unicodeC / Sunshine Conversations API / Create Integration

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *Id;
    const wchar_t *v_Type;
    const wchar_t *Status;
    const wchar_t *DisplayName;
    const wchar_t *ServerId;
    BOOL CanUserCreateMoreConversations;

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

    http = CkHttpW_Create();

    CkHttpW_putBasicAuth(http,TRUE);
    CkHttpW_putLogin(http,L"username");
    CkHttpW_putPassword(http,L"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 = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"type",L"android");
    CkJsonObjectW_UpdateString(json,L"status",L"inactive");
    CkJsonObjectW_UpdateString(json,L"displayName",L"Channel name");

    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");

    resp = CkHttpW_PostJson3(http,L"https://domain.com/",L"application/json",json);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Id = CkJsonObjectW_stringOf(jResp,L"integration.id");
    v_Type = CkJsonObjectW_stringOf(jResp,L"integration.type");
    Status = CkJsonObjectW_stringOf(jResp,L"integration.status");
    DisplayName = CkJsonObjectW_stringOf(jResp,L"integration.displayName");
    ServerId = CkJsonObjectW_stringOf(jResp,L"integration.serverId");
    CanUserCreateMoreConversations = CkJsonObjectW_BoolOf(jResp,L"integration.canUserCreateMoreConversations");


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

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