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.
# {
# "partnerId": "{{partner_id}}",
# "name": "{{product_name}}",
# "listingName": "{{product_listing_name}}",
# "tags": {
# "applications": [
# "LO Connect",
# "Encompass Smart Client"
# ],
# "categories": [
# "{{service_category}}"
# ],
# "workflows": [
# "interactive"
# ]
# },
# "integrationType": "ASYNC",
# "interfaceUrl": "{{product_interface_url}}",
# "webhooks": [
# {
# "resource": "urn:elli:epc:transaction",
# "events": [
# "created",
# "updated"
# ],
# "signingkey": "qwertyuiop1234567890!@#$f*()",
# "url": "{{webhook_url}}"
# },
# {
# "resource": "urn:elli:epc:transaction:event",
# "events": [
# "created"
# ],
# "signingkey": "qwertyuiop1234567890!@#$f*()",
# "url": "{{webhook_url}}"
# }
# ],
# "requestTypes": [
# "{{request_type}}"
# ],
# "entitlements": {
# "access": {
# "allow": [
# "urn:elli:encompass:{{encompass_instance_id}}"
# ],
# "deny": [
# ]
# }
# },
# "credential": {
# "required": [
# "username",
# "password"
# ],
# "properties": {
# "username": {
# "type": "String",
# "title": "Username"
# },
# "password": {
# "type": "String",
# "title": "Password",
# "secret": true
# }
# }
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("partnerId","{{partner_id}}")
json.UpdateString("name","{{product_name}}")
json.UpdateString("listingName","{{product_listing_name}}")
json.UpdateString("tags.applications[0]","LO Connect")
json.UpdateString("tags.applications[1]","Encompass Smart Client")
json.UpdateString("tags.categories[0]","{{service_category}}")
json.UpdateString("tags.workflows[0]","interactive")
json.UpdateString("integrationType","ASYNC")
json.UpdateString("interfaceUrl","{{product_interface_url}}")
json.UpdateString("webhooks[0].resource","urn:elli:epc:transaction")
json.UpdateString("webhooks[0].events[0]","created")
json.UpdateString("webhooks[0].events[1]","updated")
json.UpdateString("webhooks[0].signingkey","qwertyuiop1234567890!@#$f*()")
json.UpdateString("webhooks[0].url","{{webhook_url}}")
json.UpdateString("webhooks[1].resource","urn:elli:epc:transaction:event")
json.UpdateString("webhooks[1].events[0]","created")
json.UpdateString("webhooks[1].signingkey","qwertyuiop1234567890!@#$f*()")
json.UpdateString("webhooks[1].url","{{webhook_url}}")
json.UpdateString("requestTypes[0]","{{request_type}}")
json.UpdateString("entitlements.access.allow[0]","urn:elli:encompass:{{encompass_instance_id}}")
json.UpdateNewArray("entitlements.access.deny")
json.UpdateString("credential.required[0]","username")
json.UpdateString("credential.required[1]","password")
json.UpdateString("credential.properties.username.type","String")
json.UpdateString("credential.properties.username.title","Username")
json.UpdateString("credential.properties.password.type","String")
json.UpdateString("credential.properties.password.title","Password")
json.UpdateBool("credential.properties.password.secret",true)
# Adds the "Authorization: Bearer {{partner_token}}" header.
http.put_AuthToken("{{partner_token}}")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/partner/v2/products?view=complete","application/json",json)
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 {{partner_token}}"
-H "Content-Type: application/json"
-d '{
"partnerId": "{{partner_id}}",
"name": "{{product_name}}",
"listingName": "{{product_listing_name}}",
"tags": {
"applications": [
"LO Connect",
"Encompass Smart Client"
],
"categories": [
"{{service_category}}"
],
"workflows": [
"interactive"
]
},
"integrationType": "ASYNC",
"interfaceUrl": "{{product_interface_url}}",
"webhooks": [
{
"resource": "urn:elli:epc:transaction",
"events": [
"created",
"updated"
],
"signingkey": "qwertyuiop1234567890!@#$%^&*()",
"url": "{{webhook_url}}"
},
{
"resource": "urn:elli:epc:transaction:event",
"events": [
"created"
],
"signingkey": "qwertyuiop1234567890!@#$%^&*()",
"url": "{{webhook_url}}"
}
],
"requestTypes": [
"{{request_type}}"
],
"entitlements": {
"access": {
"allow": [
"urn:elli:encompass:{{encompass_instance_id}}"
],
"deny": []
}
},
"credential": {
"required": [
"username",
"password"
],
"properties": {
"username": {
"type": "String",
"title": "Username"
},
"password": {
"type": "String",
"title": "Password",
"secret": true
}
}
}
}'
https://domain.com/partner/v2/products?view=complete
Postman Collection Item JSON
{
"name": "[Partner] Create a New Product",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"// Extract Product identifier from response body",
"var jsonData = JSON.parse(responseBody);",
"var productId = jsonData.id;",
"",
"// Set to an environment variable",
"postman.setEnvironmentVariable(\"product_id\", productId);"
]
}
}
],
"_postman_id": "677a22b1-31ae-4dde-a759-f6a27216e2d5",
"request": {
"method": "POST",
"header": [
{
"key": "Authorization",
"type": "text",
"value": "Bearer {{partner_token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"partnerId\": \"{{partner_id}}\",\n \"name\": \"{{product_name}}\",\n \"listingName\": \"{{product_listing_name}}\",\n \"tags\": {\n \"applications\": [\n \"LO Connect\",\n \"Encompass Smart Client\"\n ],\n \"categories\": [\n \"{{service_category}}\"\n ],\n \"workflows\": [\n \"interactive\"\n ]\n },\n \"integrationType\": \"ASYNC\",\n \"interfaceUrl\": \"{{product_interface_url}}\",\n \"webhooks\": [\n {\n \"resource\": \"urn:elli:epc:transaction\",\n \"events\": [\n \"created\",\n \"updated\"\n ],\n \"signingkey\": \"qwertyuiop1234567890!@#$%^&*()\",\n \"url\": \"{{webhook_url}}\"\n },\n {\n \"resource\": \"urn:elli:epc:transaction:event\",\n \"events\": [\n \"created\"\n ],\n \"signingkey\": \"qwertyuiop1234567890!@#$%^&*()\",\n \"url\": \"{{webhook_url}}\"\n }\n ],\n \"requestTypes\": [\n \"{{request_type}}\"\n ],\n \"entitlements\": {\n \"access\": {\n \"allow\": [\n \"urn:elli:encompass:{{encompass_instance_id}}\"\n ],\n \"deny\": []\n }\n },\n \"credential\": {\n \"required\": [\n \"username\",\n \"password\"\n ],\n \"properties\": {\n \"username\": {\n \"type\": \"String\",\n \"title\": \"Username\"\n },\n \"password\": {\n \"type\": \"String\",\n \"title\": \"Password\",\n \"secret\": true\n }\n }\n }\n}"
},
"url": {
"raw": "{{api_host}}/partner/v2/products?view=complete",
"host": [
"{{api_host}}"
],
"path": [
"partner",
"v2",
"products"
],
"query": [
{
"key": "view",
"value": "complete"
}
]
}
},
"response": [
]
}
