Create Configuration Template
1 min
code examples curl request post \\ \ url https //api upstartcommerce com/v1/tenants/cfg/templates \\ \ header 'accept text/plain' \\ \ header 'content type application/json' \\ \ header 'x upstart tenant string' \\ \ data '{ "name" "cybersource payment gateway configuration", "propertiesdec" "{\\"type\\" \\"object\\",\\"properties\\" {\\"merchantid\\" {\\"type\\" \\"string\\",\\"description\\" \\"merchant identifier from cybersource\\",\\"pattern\\" \\"^\[a za z0 9 ]+$\\"},\\"apikey\\" {\\"type\\" \\"string\\",\\"description\\" \\"api key for authentication\\",\\"format\\" \\"password\\",\\"minlength\\" 32},\\"apiurl\\" {\\"type\\" \\"string\\",\\"format\\" \\"uri\\",\\"default\\" \\"https //api cybersource com\\",\\"description\\" \\"cybersource api base url\\"},\\"currency\\" {\\"type\\" \\"string\\",\\"enum\\" \[\\"usd\\",\\"eur\\",\\"gbp\\"],\\"default\\" \\"usd\\",\\"description\\" \\"default currency for transactions\\"},\\"testmode\\" {\\"type\\" \\"boolean\\",\\"default\\"\ false,\\"description\\" \\"enable test mode for development\\"}},\\"required\\" \[\\"merchantid\\",\\"apikey\\"]}", "enabled" true, "accesscontrol" { "read" true, "modify" false } }'var myheaders = new headers(); myheaders append("accept", "text/plain"); myheaders append("content type", "application/json"); myheaders append("x upstart tenant", "string"); var raw = json stringify({ "name" "cybersource payment gateway configuration", "propertiesdec" "{\\"type\\" \\"object\\",\\"properties\\" {\\"merchantid\\" {\\"type\\" \\"string\\",\\"description\\" \\"merchant identifier from cybersource\\",\\"pattern\\" \\"^\[a za z0 9 ]+$\\"},\\"apikey\\" {\\"type\\" \\"string\\",\\"description\\" \\"api key for authentication\\",\\"format\\" \\"password\\",\\"minlength\\" 32},\\"apiurl\\" {\\"type\\" \\"string\\",\\"format\\" \\"uri\\",\\"default\\" \\"https //api cybersource com\\",\\"description\\" \\"cybersource api base url\\"},\\"currency\\" {\\"type\\" \\"string\\",\\"enum\\" \[\\"usd\\",\\"eur\\",\\"gbp\\"],\\"default\\" \\"usd\\",\\"description\\" \\"default currency for transactions\\"},\\"testmode\\" {\\"type\\" \\"boolean\\",\\"default\\"\ false,\\"description\\" \\"enable test mode for development\\"}},\\"required\\" \[\\"merchantid\\",\\"apikey\\"]}", "enabled" true, "accesscontrol" { "read" true, "modify" false } }); var requestoptions = { method 'post', headers myheaders, body raw, redirect 'follow' }; fetch("https //api upstartcommerce com/v1/tenants/cfg/templates", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));require "uri" require "json" require "net/http" url = uri("https //api upstartcommerce com/v1/tenants/cfg/templates") https = net http new(url host, url port) https use ssl = true request = net http post new(url) request\["accept"] = "text/plain" request\["content type"] = "application/json" request\["x upstart tenant"] = "string" request body = json dump({ "name" "cybersource payment gateway configuration", "propertiesdec" "{\\"type\\" \\"object\\",\\"properties\\" {\\"merchantid\\" {\\"type\\" \\"string\\",\\"description\\" \\"merchant identifier from cybersource\\",\\"pattern\\" \\"^\[a za z0 9 ]+$\\"},\\"apikey\\" {\\"type\\" \\"string\\",\\"description\\" \\"api key for authentication\\",\\"format\\" \\"password\\",\\"minlength\\" 32},\\"apiurl\\" {\\"type\\" \\"string\\",\\"format\\" \\"uri\\",\\"default\\" \\"https //api cybersource com\\",\\"description\\" \\"cybersource api base url\\"},\\"currency\\" {\\"type\\" \\"string\\",\\"enum\\" \[\\"usd\\",\\"eur\\",\\"gbp\\"],\\"default\\" \\"usd\\",\\"description\\" \\"default currency for transactions\\"},\\"testmode\\" {\\"type\\" \\"boolean\\",\\"default\\"\ false,\\"description\\" \\"enable test mode for development\\"}},\\"required\\" \[\\"merchantid\\",\\"apikey\\"]}", "enabled" true, "accesscontrol" { "read" true, "modify" false } }) response = https request(request) puts response read body import requests import json url = "https //api upstartcommerce com/v1/tenants/cfg/templates" payload = json dumps({ "name" "cybersource payment gateway configuration", "propertiesdec" "{\\"type\\" \\"object\\",\\"properties\\" {\\"merchantid\\" {\\"type\\" \\"string\\",\\"description\\" \\"merchant identifier from cybersource\\",\\"pattern\\" \\"^\[a za z0 9 ]+$\\"},\\"apikey\\" {\\"type\\" \\"string\\",\\"description\\" \\"api key for authentication\\",\\"format\\" \\"password\\",\\"minlength\\" 32},\\"apiurl\\" {\\"type\\" \\"string\\",\\"format\\" \\"uri\\",\\"default\\" \\"https //api cybersource com\\",\\"description\\" \\"cybersource api base url\\"},\\"currency\\" {\\"type\\" \\"string\\",\\"enum\\" \[\\"usd\\",\\"eur\\",\\"gbp\\"],\\"default\\" \\"usd\\",\\"description\\" \\"default currency for transactions\\"},\\"testmode\\" {\\"type\\" \\"boolean\\",\\"default\\"\ false,\\"description\\" \\"enable test mode for development\\"}},\\"required\\" \[\\"merchantid\\",\\"apikey\\"]}", "enabled" true, "accesscontrol" { "read" true, "modify" false } }) headers = { 'accept' 'text/plain', 'content type' 'application/json', 'x upstart tenant' 'string' } response = requests request("post", url, headers=headers, data=payload) print(response text) responses // success template created successfully returns the generated template id // the request contained information that the server was unable to process appropriate errors are provided in the response body { "name" "validationerror", "code" "schema validation failed", "detail" "configuration data validation failed data apikey is required but was not provided expected string with minimum length 32 " }// the provided credentials were not valid for this endpoint it may be that they are expired or that the user's roles are insufficient { "name" "resourcenotfounderror", "code" "template not found", "detail" "the configuration template with id \\"payment stripe\\" was not found in the system ", "reason" "the template may have been deleted or you may not have permission to access it verify the template id using get /tenants/cfg/templates " }// the request conflicts with the current state of the resource this typically occurs when trying to create a resource that already exists or when there's a conflict with business rules { "name" "resourcenotfounderror", "code" "template not found", "detail" "the configuration template with id \\"payment stripe\\" was not found in the system ", "reason" "the template may have been deleted or you may not have permission to access it verify the template id using get /tenants/cfg/templates " }// the request was well formed but contains semantic errors or violates business rules that prevent processing { "name" "resourcenotfounderror", "code" "template not found", "detail" "the configuration template with id \\"payment stripe\\" was not found in the system ", "reason" "the template may have been deleted or you may not have permission to access it verify the template id using get /tenants/cfg/templates " }// an unexpected internal server error occurred the request may be retried, and if the problem persists, contact support with the traceid from the error response { "name" "resourcenotfounderror", "code" "template not found", "detail" "the configuration template with id \\"payment stripe\\" was not found in the system ", "reason" "the template may have been deleted or you may not have permission to access it verify the template id using get /tenants/cfg/templates " }