Chilkat Online Tools

PowerBuilder / Commercetools / Create Subscription

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "destination": {
//     "type": "IronMQ",
//     "uri": "https://queue-uri"
//   },
//   "messages": [
//     {
//       "resourceTypeId": "product",
//       "types": [
//       ]
//     }
//   ],
//   "key": "test-queue"
// }

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_Json.UpdateString("destination.type","IronMQ")
loo_Json.UpdateString("destination.uri","https://queue-uri")
loo_Json.UpdateString("messages[0].resourceTypeId","product")
loo_Json.UpdateNewArray("messages[0].types")
loo_Json.UpdateString("key","test-queue")

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")

loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

loo_Json.EmitSb(loo_SbRequestBody)

loo_Resp = loo_Http.PTextSb("post","https://domain.com/{{project-key}}/subscriptions",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbRequestBody
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "destination" : {
    "type" : "IronMQ",
    "uri" : "https://queue-uri"
  },
  "messages" : [ {
    "resourceTypeId" : "product",
    "types" : [ ]
  } ],
  "key" : "test-queue"
}'
https://domain.com/{{project-key}}/subscriptions

Postman Collection Item JSON

{
  "name": "Create Subscription",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "tests[\"Status code \" + responseCode.code] = responseCode.code === 200 || responseCode.code === 201;",
          "var data = JSON.parse(responseBody);",
          "if(data.results && data.results[0] && data.results[0].id && data.results[0].version){",
          "    pm.environment.set(\"subscription-id\", data.results[0].id); ",
          "    pm.environment.set(\"subscription-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"subscription-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"subscription-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"subscription-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"subscription-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/subscriptions",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "subscriptions"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "The creation of a Subscription is eventually consistent, it may take up to a minute before it becomes fully active.\nIn order to test that the destination is correctly configured, a test message will be put into the queue.\nIf the message could not be delivered, the subscription will not be created.\nThe payload of the test message is a notification of type ResourceCreated for the resourceTypeId subscription.\nCurrently, a maximum of 25 subscriptions can be created per project.\n",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"destination\" : {\n    \"type\" : \"IronMQ\",\n    \"uri\" : \"https:\/\/queue-uri\"\n  },\n  \"messages\" : [ {\n    \"resourceTypeId\" : \"product\",\n    \"types\" : [ ]\n  } ],\n  \"key\" : \"test-queue\"\n}"
    }
  },
  "response": [
  ]
}