Chilkat Online Tools

Ruby / Commercetools / Create Extension

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": "HTTP",
#     "url": "https://example.azurewebsites.net/api/extension",
#     "authentication": {
#       "type": "AzureFunctions",
#       "key": "some-azure-function-code"
#     }
#   },
#   "triggers": [
#     {
#       "resourceTypeId": "cart",
#       "actions": [
#         "Create",
#         "Update"
#       ]
#     }
#   ],
#   "key": "my-extension"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("destination.type","HTTP")
json.UpdateString("destination.url","https://example.azurewebsites.net/api/extension")
json.UpdateString("destination.authentication.type","AzureFunctions")
json.UpdateString("destination.authentication.key","some-azure-function-code")
json.UpdateString("triggers[0].resourceTypeId","cart")
json.UpdateString("triggers[0].actions[0]","Create")
json.UpdateString("triggers[0].actions[1]","Update")
json.UpdateString("key","my-extension")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("post","https://domain.com/{{project-key}}/extensions",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "destination" : {
    "type" : "HTTP",
    "url" : "https://example.azurewebsites.net/api/extension",
    "authentication" : {
      "type" : "AzureFunctions",
      "key" : "some-azure-function-code"
    }
  },
  "triggers" : [ {
    "resourceTypeId" : "cart",
    "actions" : [ "Create", "Update" ]
  } ],
  "key" : "my-extension"
}'
https://domain.com/{{project-key}}/extensions

Postman Collection Item JSON

{
  "name": "Create Extension",
  "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(\"extension-id\", data.results[0].id); ",
          "    pm.environment.set(\"extension-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"extension-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"extension-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"extension-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"extension-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}}/extensions",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "extensions"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "Currently, a maximum of 25 extensions can be created per project.",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"destination\" : {\n    \"type\" : \"HTTP\",\n    \"url\" : \"https:\/\/example.azurewebsites.net\/api\/extension\",\n    \"authentication\" : {\n      \"type\" : \"AzureFunctions\",\n      \"key\" : \"some-azure-function-code\"\n    }\n  },\n  \"triggers\" : [ {\n    \"resourceTypeId\" : \"cart\",\n    \"actions\" : [ \"Create\", \"Update\" ]\n  } ],\n  \"key\" : \"my-extension\"\n}"
    }
  },
  "response": [
  ]
}