Chilkat Online Tools

Ruby / Commercetools / Create ApiClient

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.

# {
#   "name": "api-client-name",
#   "scope": "view_products"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("name","api-client-name")
json.UpdateString("scope","view_products")

# 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}}/api-clients",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 '{
  "name" : "api-client-name",
  "scope" : "view_products"
}'
https://domain.com/{{project-key}}/api-clients

Postman Collection Item JSON

{
  "name": "Create ApiClient",
  "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(\"api-client-id\", data.results[0].id); ",
          "    pm.environment.set(\"api-client-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"api-client-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"api-client-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"api-client-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"api-client-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}}/api-clients",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "api-clients"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "null",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\" : \"api-client-name\",\n  \"scope\" : \"view_products\"\n}"
    }
  },
  "response": [
  ]
}