The XContentCloud APIs provide a simple and direct approach to content generation. The API can be embedded in simple HTML content, such an email, a website, marketing-automation tools, or CMS. It can also be be called from a client or server code. The content is divided to three distinct groups:
\nThis method initiates the creation of a project that includes the upload of the DPKG file.\nUsing the method returns a URL to which to upload the file.\nReturns {fileUploadUrl,key}.
\nUpload the file to the fileUploadUrl URL using a PUT http command. Once upload is complete, call the following create method with the key to complete the project creation process.
Upload the DPKG file to the signed URL parameter fileUploadUrl from previous step
Calculated by createHeadersHmac first value
\n","key":"hmacHeader","type":"text","value":"{{xmpiehmacHeader}}"},{"description":"Calculated by createHeadersHmac second value
\n","key":"timestamp","type":"text","value":"{{xmpiehtimestampHeader}}"}],"body":{"mode":"raw","raw":"{\n\t\"key\" : \"{{xmpieuimageputkey}}\",\n\t\"tags\" : [{\"key\":\"UFIRST\",\"value\":\"Sujit\"}],\n\t\"keywords\" : \"Spray, Paint, Cloud\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.xcontentcloud.com/v1/image/create/:customer/:project","description":"After uploading the DPKG file, call this method to complete the project creation process. Pass the key returned from the fileUpload URL method.\nIn addition you need to specify the tags that are used by the project and comma delimited keywords to describe your project.
\nThis method runs asynchronously.
\nFor request authorization add the following headers: hmacHeader,timestamp. See HMAC functions above.
Customer ID
\n","type":"text/plain"},"type":"string","value":"{{xmpiecustomer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{xmpieproject}}","key":"project"}]}},"response":[{"id":"b98f67da-3fdf-4901-a9fa-5a73fa102d5b","name":"Async create new project","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json; charset=utf-8"},{"key":"hmacHeader","type":"text","value":"{{xmpiehmacHeader}}"},{"key":"timestamp","type":"text","value":"{{xmpiehtimestampHeader}}"}],"body":{"mode":"raw","raw":"{\n\t\"key\" : \"{{xmpieuimageputkey}}\",\n\t\"tags\" : [{\"key\":\"UFIRST\",\"value\":\"Demo\"}],\n\t\"keywords\" : \"Sky, Blue, Wind\"\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.xcontentcloud.com/v1/image/create/:customer/:project","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","image","create",":customer",":project"],"variable":[{"key":"customer","value":"{{xmpiecustomer}}","description":"Customer ID"},{"key":"project","value":"{{xmpieproject}}","description":"Project ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 04 Mar 2020 15:09:58 GMT"},{"key":"x-amzn-RequestId","value":"1d4babaa-2d20-4dff-94f9-9b419439951a"},{"key":"x-amz-apigw-id","value":"I3uujG7bIAMFRpQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5e5fc4c3-d7f53ea78db8ec261b27a462"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ab5a0b129a46042ccb6b286f29e7940c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"OtjH_e0MgRtXtX0XZ7k0zJqmTjDgCrpBR8ge9QY3kCByrxZhrUyz0Q=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"project\": \"SprayingPaintLowRes\"\n}"}],"_postman_id":"dc65821d-0fd4-40a9-99df-bbc80fcfa890"},{"name":"Async delete project","event":[{"listen":"prerequest","script":{"id":"223f1c56-cf41-4086-9608-dd02cc1dc694","exec":["var key = postman.getEnvironmentVariable(\"xmpiecustomer\"); \r","var secret = postman.getEnvironmentVariable(\"xmpiesecret\");\r","var customerName = postman.getEnvironmentVariable(\"xmpiecustomer\"); \r","var documentName = postman.getEnvironmentVariable(\"xmpieproject\"); \r","var endpoint = \"api.xcontentcloud.com/v1/image/customer/\" + customerName + \"/\" + documentName;\r","console.log ('Endpoint is: ' + endpoint);\r","const serialize = obj => obj.map(p => encodeURIComponent(p.key) + '=' + encodeURIComponent(p.value))\r",".sort((a,b)=>{ if(aCalculated by createHeadersHmac first value
\n","key":"hmacHeader","type":"text","value":"{{xmpiehmacHeader}}"},{"description":"Calculated by createHeadersHmac second value
\n","key":"timestamp","type":"text","value":"{{xmpiehtimestampHeader}}"}],"url":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project","description":"Delete the project and all assets associated with the project.\nFor request authorization add the following headers: hmacHeader,timestamp. See HMAC functions above.
Customer ID
\n","type":"text/plain"},"type":"string","value":"{{xmpiecustomer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{xmpieproject}}","key":"project"}]}},"response":[{"id":"02e9912a-6c29-4c63-b4a1-20325cbb65c2","name":"Async delete project","originalRequest":{"method":"DELETE","header":[{"key":"hmacHeader","value":"{{xmpiehmacHeader}}","type":"text"},{"key":"timestamp","value":"{{xmpiehtimestampHeader}}","type":"text"}],"url":{"raw":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","image","customer",":customer",":project"],"variable":[{"key":"customer","value":"{{xmpiecustomer}}","description":"Customer ID"},{"key":"project","value":"{{xmpieproject}}","description":"Project ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 09 Feb 2020 14:57:31 GMT"},{"key":"x-amzn-RequestId","value":"a01fa742-825e-4e7f-bd00-ae63bf0d0a46"},{"key":"x-amz-apigw-id","value":"HomaKF8ZIAMFy4Q="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5e401dda-cd8d2cba1acba525763a6748;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 d5d5fbb221d1e1e64574f5113ce6ed5c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"inLWc95BHGAESgX5WDMswK35qehWfgZbrYKKR1fjHLvxbmbNofJSdA=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"4f9cd2ff-4aa0-47ed-bf78-92e51603ab87"},{"name":"Synchronous search projects","event":[{"listen":"prerequest","script":{"id":"7065a8f0-2036-4286-922a-f2798c87abdd","exec":["var key = postman.getEnvironmentVariable(\"xmpiecustomer\"); \r","var secret = postman.getEnvironmentVariable(\"xmpiesecret\");\r","var customerName = postman.getEnvironmentVariable(\"xmpiecustomer\"); \r","//key = \"TestMosaic1\";\r","var endpoint = \"api.xcontentcloud.com/v1/image/search/customer/\" + customerName;\r","console.log ('Endpoint is: ' + endpoint);\r","const serialize = obj => obj.map(p => p.key + '=' + p.value.trim())\r",".sort((a,b)=>{ if(aCalculated by createHeadersHmac first value
\n","key":"hmacHeader","type":"text","value":"{{xmpiehmacHeader}}"},{"description":"Calculated by createHeadersHmac second value
\n","key":"timestamp","type":"text","value":"{{xmpiehtimestampHeader}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.xcontentcloud.com/v1/image/search/customer/:customer?query=keywords contains paint","description":"List all the projects or filter the list with the query expression. Query expressions are ‘equals’,’contains’,’not-contains’, 'begins-with'. For example ?query=project equals christmas 2019, Or ?query=project not-contains summer.\nFor request authorization add the following headers: hmacHeader,timestamp. See HMAC functions above.
Customer ID
\n","type":"text/plain"},"type":"string","value":"{{xmpiecustomer}}","key":"customer"}]}},"response":[{"id":"bdacce9e-2f4b-4313-b6b5-1be03f24dc61","name":"Search projects","originalRequest":{"method":"GET","header":[{"key":"hmacHeader","type":"text","value":"{{xmpiehmacHeader}}"},{"key":"timestamp","type":"text","value":"{{xmpiehtimestampHeader}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.xcontentcloud.com/v1/image/search/customer/:customer?query=tags contains ufirst","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","image","search","customer",":customer"],"query":[{"key":"query","value":"tags contains ufirst"}],"variable":[{"key":"customer","value":"{{xmpiecustomer}}","description":"Customer ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"696"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 04 Mar 2020 15:24:34 GMT"},{"key":"x-amzn-RequestId","value":"760b9c7f-2b21-4be5-b9a5-696f17e2ddf5"},{"key":"x-amz-apigw-id","value":"I3w3hEVnIAMF7vA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5e5fc830-02bf54686b6668bb75a1e713"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 7d30cf029bde247eef16106ceffb39cb.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"-d3uasPrBMdpBPxXHWgs93PxYOwbOZmgakQ0UvOorvJhLcK5_pkfgg=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"project\": \"SprayingPaintLowRes18\",\n \"created\": \"2020-03-04T14:02:36.533+00:00\",\n \"modified\": \"2020-03-04T14:02:36.563+00:00\",\n \"tags\": [\n {\n \"Value\": \"Demo\",\n \"Name\": \"UFIRST\"\n }\n ],\n \"keywords\": \"Office, Accounting, Blue\",\n \"thumbnail\": \"https://api.xcontentcloud.com/v1/image/customer/UImageDevTester/SprayingPaintLowRes18?contentId=7aaf01e6-b318-4c45-9121-c362a760281b\"\n },\n {\n \"project\": \"SprayingPaintLowRes19\",\n \"created\": \"2020-03-04T15:09:52.927+00:00\",\n \"modified\": \"2020-03-04T15:09:52.947+00:00\",\n \"tags\": [\n {\n \"value\": \"Demo\",\n \"key\": \"UFIRST\"\n }\n ],\n \"keywords\": \"Office, Accounting, Blue\",\n \"thumbnail\": \"https://api.xcontentcloud.com/v1/image/customer/UImageDevTester/SprayingPaintLowRes19?contentId=8ebbd0c9-d4fa-4727-8b20-7f1fe56cc8fd\"\n }\n]"}],"_postman_id":"e5f79061-5a21-43f4-be93-3ea980e518d8"}],"id":"de4fefac-9a2d-4652-817d-5f83e322adbb","description":"Use these APIs to manage projects. APIs to upload new projects, delete existing projects and view a list of projects.
\n","event":[{"listen":"prerequest","script":{"id":"f11d21b0-043f-4494-892c-8722b3ab87a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"59e69c74-ca09-463e-9c63-939288d91985","type":"text/javascript","exec":[""]}}],"_postman_id":"de4fefac-9a2d-4652-817d-5f83e322adbb"},{"name":"Synchronous get image","event":[{"listen":"prerequest","script":{"id":"bed3b3ff-f944-4d21-81ae-dfbba4c37296","exec":["","var project = postman.getEnvironmentVariable(\"xmpieproject\"); ","var customerName = postman.getEnvironmentVariable(\"xmpiecustomer\"); ","var ador = postman.getEnvironmentVariable(\"xmpieador\"); ","var val = postman.getEnvironmentVariable(\"xmpieadorvalue\"); ","var params = ador + \"=\" + encodeURIComponent(val);","pm.variables.set(\"project\",project);","pm.variables.set(\"customerID\",customerName );","pm.variables.set(\"params\",params);","","var key = postman.getEnvironmentVariable(\"xmpiecustomer\"); ","var secret = postman.getEnvironmentVariable(\"xmpiesecret\");","var endpoint = \"api.xcontentcloud.com/v1/image/customer/\" + encodeURIComponent(customerName) + \"/\" + encodeURIComponent(project) + \"?\" + params;","console.log ('Endpoint is: ' + endpoint);","","var headers = createHeaders(customerName,\"GET\", endpoint);","pm.environment.set(\"xmpiehmac\", headers[0]);","","","function createHeaders(customer,method, path) {"," var toSign = method.toUpperCase() + \" \" + path;"," pm.environment.set(\"ph\", toSign);"," var hash = CryptoJS.HmacSHA1(toSign, key + \":\" + secret);"," var sig = CryptoJS.enc.Hex.stringify(hash);"," var headers = ["," customer + \":\" + sig"," ];"," return headers;","}"],"type":"text/javascript"}}],"id":"b86a139b-9a3c-453a-a3b8-ad533d009901","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project?{{params}}&HMAC={{xmpiehmac}}","description":"Generate a production grade image from a preloaded project, using all of the provided attributes.\nFor request authorization add &HMAC=HMAC-VALUE
Customer ID
\n","type":"text/plain"},"type":"string","value":"{{xmpiecustomer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{xmpieproject}}","key":"project"}]}},"response":[{"id":"ee694fee-0a8f-42b7-8bec-11521baa4528","name":"Synchronous get image","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project?FNAME=John","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","image","customer",":customer",":project"],"query":[{"key":"FNAME","value":"John"}],"variable":[{"description":"Customer ID","key":"customer","value":"Xerox"},{"description":"Project ID","key":"project","value":"X_03394_W6_DM_FirstmoveMOFU5_Banner_4"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b86a139b-9a3c-453a-a3b8-ad533d009901"},{"name":"Async get image","event":[{"listen":"prerequest","script":{"id":"acf090f3-2be8-4aee-9ed9-38c91cc58392","exec":["var key = postman.getEnvironmentVariable(\"xmpiecustomer\"); ","var secret = postman.getEnvironmentVariable(\"xmpiesecret\");","var customerName = postman.getEnvironmentVariable(\"xmpiecustomer\"); ","var documentName = postman.getEnvironmentVariable(\"xmpieproject\"); ","","pm.variables.set(\"project\",documentName);","pm.variables.set(\"customer\",customerName );","var endpoint = \"api.xcontentcloud.com/v1/image/customer/\" + customerName + \"/\" + documentName;","console.log ('Endpoint is: ' + endpoint);","const serialize = obj => obj.map(p => encodeURIComponent(p.key) + '=' + encodeURIComponent(p.value))",".sort((a,b)=>{ if(aCalculated by createHeadersHmac first value
\n","key":"hmacHeader","type":"text","value":"{{xmpiehmacHeader}}"},{"description":"Calculated by createHeadersHmac second value
\n","key":"timestamp","type":"text","value":"{{xmpiehtimestampHeader}}"}],"body":{"mode":"raw","raw":"{\n\t\"parameters\":{\n\t\t\"{{xmpieador}}\":\"{{xmpieadorvalue}}\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project","description":"Asynchronously generate an image from project. Use the Get image generation status to verify generation is complete and to retrieve the URL to the generated image.
\nThe parameters are mandatory a set of key values tags that are required for the project.
\nFor request authorization add the following headers: hmacHeader,timestamp. See HMAC functions above.
Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"a818f6e9-6a7d-463a-aecf-7dc9238c5f51","name":"Async get image","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"hmacHeader","value":"{{xmpiehmacHeader}}","type":"text"},{"key":"timestamp","value":"{{xmpiehtimestampHeader}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"parameters\":{\n\t\t\"{{xmpieador}}\":\"{{xmpieadorvalue}}\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","image","customer",":customer",":project"],"variable":[{"key":"customer","value":"{{customer}}","description":"Customer ID"},{"key":"project","value":"{{project}}","description":"Project ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 10 Feb 2020 13:34:15 GMT"},{"key":"x-amzn-RequestId","value":"2c53203b-828b-4bc7-8e05-d74839b21b5b"},{"key":"x-amz-apigw-id","value":"HrtJRHPioAMFQTA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5e415bd4-5699153ec163eb79494bd5bc;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fd3f7297d4c0245a27d5177644dc8e9a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"d_8r3Gt4FL10fyY3iBY69WIemHxPWlROmKu1EwN1Reor0rjBdHSE9w=="}],"cookie":[],"responseTime":null,"body":"\"{\\\"status\\\":\\\"ok\\\",\\\"contentId\\\":\\\"b281d132-22dd-44a4-9c23-a8dc0f232b2f\\\"}\""}],"_postman_id":"9949f7d3-a2f3-4e66-9a3c-f53201e91fb1"},{"name":"Async get image status by content ID","event":[{"listen":"prerequest","script":{"id":"7e6a05b6-f01d-4368-9afa-22289ca2e5f1","exec":["var customerName = postman.getEnvironmentVariable(\"xmpiecustomer\"); ","var documentName = postman.getEnvironmentVariable(\"xmpieproject\"); ","var contentId = postman.getEnvironmentVariable(\"contentId\");","pm.variables.set(\"project\",documentName);","pm.variables.set(\"customer\",customerName );","pm.variables.set(\"contentId\",contentId);"],"type":"text/javascript"}}],"id":"594b7533-a47c-43b5-80c6-a5d1b7cc23fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project/status?contentId={{contentId}}","description":"Checks the image generation status by content ID returned by the POST Generate image method. Responds with the status, and when image is ready, with a URL to the image.
\n","urlObject":{"protocol":"https","path":["v1","image","customer",":customer",":project","status"],"host":["api","xcontentcloud","com"],"query":[{"description":{"content":"The content ID returned by the async generate image method
\n","type":"text/plain"},"key":"contentId","value":"{{contentId}}"}],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"bec17a8e-a4d7-455c-922d-d8a83485779d","name":"Async get image status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project/status?contentId=f8d78766-e57f-4e89-a11c-960bef5e2136","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","image","customer",":customer",":project","status"],"query":[{"key":"contentId","value":"f8d78766-e57f-4e89-a11c-960bef5e2136"}],"variable":[{"key":"customer","value":"Xerox","description":"Customer ID"},{"key":"project","value":"X_03394_W6_DM_FirstmoveMOFU5_Banner_4","description":"Project ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"268"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 27 Nov 2019 13:15:51 GMT"},{"key":"x-amzn-RequestId","value":"881f2820-d9ed-4343-8b68-85764765e884"},{"key":"x-amz-apigw-id","value":"D0eJAHuXoAMFa1A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5dde7706-64fd101c04195994990b1a3c;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 399b5715f700bb807285dd950c15453e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"jg-wwXFE_nQTAhircWwrukU7NuNLwdqfcD4rI5UmNQFeJXFBuRhezA=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ready\",\n \"url\": \"https://s3.amazonaws.com/dynamicfiles/16EAD00F1FD7163E2B7F6B4306241B6A.jpg\",\n \"contentId\": \"f8d78766-e57f-4e89-a11c-960bef5e2136\"\n}"}],"_postman_id":"594b7533-a47c-43b5-80c6-a5d1b7cc23fc"},{"name":"Async get image by content ID","event":[{"listen":"prerequest","script":{"id":"18aef258-ff70-4976-8956-d91c5ded9471","exec":["var customerName = postman.getEnvironmentVariable(\"xmpiecustomer\"); ","var documentName = postman.getEnvironmentVariable(\"xmpieproject\"); ","var contentId = postman.getEnvironmentVariable(\"contentId\");","pm.variables.set(\"project\",documentName);","pm.variables.set(\"customer\",customerName );","pm.variables.set(\"contentId\",contentId);"],"type":"text/javascript"}}],"id":"d19e96b3-b3fa-4b3e-9b06-0a4a162a3a3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.xcontentcloud.com/v1/image/customer/:customer/:project?contentId={{contentId}}","description":"Async get a image stream by the content ID returned by the async generate image.
\n","urlObject":{"protocol":"https","path":["v1","image","customer",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[{"description":{"content":"The content ID returned by the async generate image method
\n","type":"text/plain"},"key":"contentId","value":"{{contentId}}"}],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"d19e96b3-b3fa-4b3e-9b06-0a4a162a3a3b"},{"name":"Synchronous get Image with watermark","event":[{"listen":"prerequest","script":{"id":"c27ff768-f1d0-491c-9996-ec76a531fa59","exec":["pm.variables.set(\"project\",\"TwoHotAirBalloons\");","pm.variables.set(\"params\",\"UFIRST=JohnDoe\");"],"type":"text/javascript"}}],"id":"147ab6d2-216a-4c6d-8d56-80af62fa8d97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://api.xcontentcloud.com/v1/image/sample/:project?{{params}}","description":"Generate a low resolution XMPie watermarked image from a preloaded project, using all of the provided attributes.
\n","urlObject":{"protocol":"http","path":["v1","image","sample",":project"],"host":["api","xcontentcloud","com"],"query":[{"description":{"content":"Tags required by the image template
\n","type":"text/plain"},"key":"{{params}}","value":null}],"variable":[{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"57577152-07c2-4a5c-803b-138e8e2c781d","name":"Synchronous get a sample image with watermark","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://api.xcontentcloud.com/v1/image/sample/:project?UFIRST=JohnDoe","protocol":"http","host":["api","xcontentcloud","com"],"path":["v1","image","sample",":project"],"query":[{"key":"UFIRST","value":"JohnDoe"}],"variable":[{"description":"Project ID","key":"project","value":"TwoHotAirBalloons"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"147ab6d2-216a-4c6d-8d56-80af62fa8d97"}],"id":"b1b060f3-ee1a-4e0a-9976-9835c0f323c2","description":"Please note that customers configured with API authorization will need to sign their requests. Requests are signed either with the Simple HMAC and require the HMAC querystring parameters to be added at the end of the query, or signed using the Header HMAC and place the hmac and timestamp in additional header parameters.
\nIn order to work properly with special characters and accented letters in path parameter, use HTML encoding.
\nBelow are the functions used to generate the HMAC.
\nThe secret used is the secret that you receive from XMPie upon registering to the service.
\nSimple HMAC function
\n
\n\n\nvar CryptoJS = require(\"crypto-js\");\nfunction createSimpleHmac(customer,method, path) {\n var toSign = method.toUpperCase() + \" \" + path;\n var hash = CryptoJS.HmacSHA1(toSign, key + \":\" + secret);\n var sig = CryptoJS.enc.Hex.stringify(hash);\n var headers = [\n customer + \":\" + sig\n ];\n return headers;\n}\n
\n\n\n\n\n\nfunction createHeadersHmac(customerName,secret,method, path,qs) {\n var timestamp = (new Date()).toISOString();\n var querystring = serialize(qs);\n var toSign = method.toUpperCase() + \" \" + path;\n if(querystring!==\"\"){\n toSign += \"?\" + querystring.toString();\n }\n toSign += \":\" + timestamp;\n var hash = CryptoJS.HmacSHA1(toSign, customerName + \":\" + secret);\n var sig = CryptoJS.enc.Hex.stringify(hash);\n var headers = [\n customerName + \":\" + sig,\n timestamp\n ];\n return headers;\n}\nconst serialize = obj => obj.map(p => encodeURIComponent(p.key) + '=' + encodeURIComponent(p.value))\n.sort((a,b)=>{ if(ab) return 1; return 0;}).join('&');\n
\n\ncreateHeadersHmac(\"MyCustomerName\",\"My*ecretKe8\",\"GET\",\"api.xcontentcloud.com/v1/image/search/customer/MyCustomerName\",[{\"key\":\"query\",\"value\":\"keywords contains flowers\"}])
\nThis method initiates the creation of a project that includes the upload of the cpkg template. \nUsing the method returns a URL to which to upload the file.
Returns {fileUploadUrl,key}.
\nUpload the file to the fileUploadUrl URL using a PUT http command. Once upload is complete, call the following create method with the key to complete the project creation process.
After uploading the template, call this method to complete the project creation process. Pass the key returned from the fileUpload URL pethood. The method runs asynchronously.
Delete the pdf template and all assets associated with the template
\n","urlObject":{"protocol":"https","path":["v1","pdf","customer",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[],"variable":[{"description":{"content":"Your customer name
\n","type":"text/plain"},"type":"string","value":"","key":"customer"},{"description":{"content":"Delete project name
\n","type":"text/plain"},"type":"string","value":"","key":"project"}]}},"response":[],"_postman_id":"31b0b16c-4b05-44bc-87cb-1f4c5c7dea04"},{"name":"Synchronous search PDF templates","id":"d51c82d9-d5b5-4b46-9e6a-4cffa7d2df30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.xcontentcloud.com/v1/pdf/search/customer/:customer?query=projectname contains expression&results_per_page=20&page=1","description":"Provide a list of project for which the query expression applies to. Query is limited to ‘equals’,’contains’,’not-contains’. For example ?query=projectname equals christmas 2019, Or ?query= projectname not-contains summer. A max of 100 result per page is allowed.
\n","urlObject":{"protocol":"https","path":["v1","pdf","search","customer",":customer"],"host":["api","xcontentcloud","com"],"query":[{"key":"query","value":"projectname contains expression"},{"key":"results_per_page","value":"20"},{"key":"page","value":"1"}],"variable":[{"type":"string","value":"","key":"customer"}]}},"response":[],"_postman_id":"d51c82d9-d5b5-4b46-9e6a-4cffa7d2df30"}],"id":"b0b24659-2d77-482d-b6a3-1c4cb20d6092","description":"Future APIs to be released in a beta version
\n","_postman_id":"b0b24659-2d77-482d-b6a3-1c4cb20d6092"},{"name":"Synchronous get PDF","event":[{"listen":"prerequest","script":{"id":"d7279971-a298-48e0-978f-015e696c2db8","exec":["pm.variables.set(\"querystring\",\"FName=YakiD&BMWColor=Red&Upholstery=White&TechData=Yes&State=IL&AgentName=Clark and White&AgentLink=https://calendly.com/bmw-Chicago/john&AgentPhone=(847) 123 12456&AgentAddress=513 Michigan Ave., NYC, NY&AgentEmail=clark@bmw.xmpie.com&uImage=0&Low=1\");","pm.variables.set(\"customer\",\"customerXMPie\");","pm.variables.set(\"project\",\"1085\");"],"type":"text/javascript"}}],"id":"258bbc53-b418-4ec5-bff8-7f75a5640400","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.xcontentcloud.com/v1/pdf/:customer/:project?{{querystring}}","description":"Synchronously request PDF with parameters. The reply is a PDF stream.
\n","urlObject":{"protocol":"https","path":["v1","pdf",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[{"description":{"content":"Tags required by the PDF template
\n","type":"text/plain"},"key":"{{querystring}}","value":null}],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"5c37393d-c5cb-4b4c-b38b-bd001fd29575","name":"Synchronous get PDF","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.xcontentcloud.com/v1/pdf/customerXMPie/1085?FName=John&BMWColor=Red&Upholstery=White&TechData=Yes&State=IL&AgentName=Clark and White&AgentLink=https://janedoe.com/bmw-Chicago/john&AgentPhone=(847) 123 12456&AgentAddress=513 Michigan Ave., NYC, NY&AgentEmail=johnd@bmw.xmpie.com&uImage=0&Low=1","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","pdf","customerXMPie","1085"],"query":[{"key":"FName","value":"John"},{"key":"BMWColor","value":"Red"},{"key":"Upholstery","value":"White"},{"key":"TechData","value":"Yes"},{"key":"State","value":"IL"},{"key":"AgentName","value":"Clark and White"},{"key":"AgentLink","value":"https://janedoe.com/bmw-Chicago/john"},{"key":"AgentPhone","value":"(847) 123 12456"},{"key":"AgentAddress","value":"513 Michigan Ave., NYC, NY"},{"key":"AgentEmail","value":"johnd@bmw.xmpie.com"},{"key":"uImage","value":"0"},{"key":"Low","value":"1"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"258bbc53-b418-4ec5-bff8-7f75a5640400"},{"name":"Async generate PDF","event":[{"listen":"prerequest","script":{"id":"d7279971-a298-48e0-978f-015e696c2db8","exec":["pm.variables.set(\"customer\",\"customerXMPie\");","pm.variables.set(\"project\",\"1085\");"],"type":"text/javascript"}}],"id":"e4f38c2d-ec05-44a3-92c7-83dc54740ace","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"parameters\":{\r\n\t\t\"FName\": \"Yakin_4\",\r\n\t\t\"BMWColor\": \"Red\",\r\n\t\t\"Upholstery\": \"White\",\r\n\t\t\"TechData\": \"Yes\",\r\n\t\t\"State\": \"IL\",\r\n\t\t\"AgentName\": \"Clark and White\",\r\n\t\t\"AgentLink\": \"https://calendly.com/bmw-Chicago/john\",\r\n\t\t\"AgentPhone\": \"(847) 123 12456&AgentAddress:513 Michigan Ave., NYC, NY\",\r\n\t\t\"AgentEmail\": \"clark@bmw.xmpie.com\",\r\n\t\t\"uImage\": 0,\r\n\t\t\"Low\": 1 \r\n\t}\r\n}"},"url":"https://api.xcontentcloud.com/v1/pdf/:customer/:project","description":"Asynchronously generate a pdf from an InDesign template. Use the Get PDF generation status to verify generation is complete and to retrieve the URL to the generated PDF.
\n","urlObject":{"protocol":"https","path":["v1","pdf",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"e4f38c2d-ec05-44a3-92c7-83dc54740ace"},{"name":"Async get PDF status by content ID","event":[{"listen":"prerequest","script":{"id":"d7279971-a298-48e0-978f-015e696c2db8","exec":["pm.variables.set(\"contentId\",\"0a3fc4e0-0b97-11ea-9f01-f1dc76e0bd56\");","pm.variables.set(\"customer\",\"customerXMPie\");","pm.variables.set(\"project\",\"1085\");"],"type":"text/javascript"}}],"id":"8ac30b47-297c-472e-82be-86cf7cf311b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.xcontentcloud.com/v1/pdf/:customer/:project/status?contentId={{contentId}}","description":"Checks the PDF generation status by content ID returned by the POST Generate PDF method. Responds with the status, and when PDF is ready, with a URL to the PDF.
\n","urlObject":{"protocol":"https","path":["v1","pdf",":customer",":project","status"],"host":["api","xcontentcloud","com"],"query":[{"description":{"content":"The content ID returned by the get/generate PDF methods
\n","type":"text/plain"},"key":"contentId","value":"{{contentId}}"}],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[],"_postman_id":"8ac30b47-297c-472e-82be-86cf7cf311b1"},{"name":"Async get PDF by content ID","event":[{"listen":"prerequest","script":{"id":"d7279971-a298-48e0-978f-015e696c2db8","exec":["pm.variables.set(\"contentId\",\"0a3fc4e0-0b97-11ea-9f01-f1dc76e0bd56\");","pm.variables.set(\"customer\",\"customerXMPie\");","pm.variables.set(\"project\",\"1085\");"],"type":"text/javascript"}}],"id":"5679962a-d533-4c22-b1f0-0dc0a1990063","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.xcontentcloud.com/v1/pdf/:customer/:project?contentid={{contentId}}","description":"Async get a PDF stream by the content ID returned by the async generate PDF.
\n","urlObject":{"protocol":"https","path":["v1","pdf",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[{"description":{"content":"The content ID returned by the get/generate PDF methods
\n","type":"text/plain"},"key":"contentid","value":"{{contentId}}"}],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"97148511-7558-4c7f-a242-05def8a3ff9d","name":"Async get PDF","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.xcontentcloud.com/v1/pdf/customerXMPie/1085?contentId=0a3fc4e0-0b97-11ea-9f01-f1dc76e0bd56","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","pdf","customerXMPie","1085"],"query":[{"key":"contentId","value":"0a3fc4e0-0b97-11ea-9f01-f1dc76e0bd56"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5679962a-d533-4c22-b1f0-0dc0a1990063"}],"id":"874cc6af-cf73-4fa5-84b8-88d02df0d981","_postman_id":"874cc6af-cf73-4fa5-84b8-88d02df0d981","description":""},{"name":"Video APIs","item":[{"name":"Synchronous get video","event":[{"listen":"prerequest","script":{"id":"24416575-93bb-4935-a0ec-89f76d59dd38","exec":["let guserName = pm.globals.get(\"guserName\");","let gpassword = pm.globals.get(\"gpassword\");","pm.variables.set(\"customer\",\"customerXMPie\");","pm.variables.set(\"project\",\"CD752E803F894565887A6D4089DEE154\");","pm.variables.set(\"querystring\",\"Name=Yaron122&color=00FFFF&picture=Italy_room.jpg&sound=audio66916.wav.mp3&picture2=ChamomileTea.jpg&Thumbnail1=http://circle.store.xmpie.com/files/logo-xmpie.png&Thumbnail2=Thumb2.jpg&UserId=\" + guserName + \"&Password=\" + gpassword);"],"type":"text/javascript"}}],"id":"92f9a241-ddcc-4967-b2fc-b169666bae6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.xcontentcloud.com/v1/video/stream/:customer/:project?{{querystring}}","description":"Generates a new video record. Send it to rendering Queue and wait for it to complete in 10 seconds.\nThis method returns a video stream if rendering completes in 10 seconds. Otherwise it returns the same result as the post action.
\n","urlObject":{"protocol":"https","path":["v1","video","stream",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[{"description":{"content":"Tags required by the video template
\n","type":"text/plain"},"key":"{{querystring}}","value":null}],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"4cb8f1d6-7183-4538-b2d7-5efd09970ce2","name":"Create and Get video by query string","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.xcontentcloud.com/v1/video/stream/customerXMPie/CD752E803F894565887A6D4089DEE154?FirstName=Tayloar&LastName=LAST%20NAME&Recipient%20Name=Tayloar&Sender%20Name=Irit&Event=Birthday&Sender%20Free%20Text=Hello&Event%20Footage=Baloons_Smaller.mp4&Coffee%20Brand%20Name=French%20Blend&Coffee%20Brand%20Image=medium%20roast-French%20Blend.png&Color=DC5AC1&Music=Pressocup_Birthday_Music.aac&XMPieRecipientKey=0390acbf94ac31076f2fef769498ae1e&userId=XMPMarketing&password=Marketing2019","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","video","stream","customerXMPie","CD752E803F894565887A6D4089DEE154"],"query":[{"key":"FirstName","value":"Tayloar"},{"key":"LastName","value":"LAST%20NAME"},{"key":"Recipient%20Name","value":"Tayloar"},{"key":"Sender%20Name","value":"Irit"},{"key":"Event","value":"Birthday"},{"key":"Sender%20Free%20Text","value":"Hello"},{"key":"Event%20Footage","value":"Baloons_Smaller.mp4"},{"key":"Coffee%20Brand%20Name","value":"French%20Blend"},{"key":"Coffee%20Brand%20Image","value":"medium%20roast-French%20Blend.png"},{"key":"Color","value":"DC5AC1"},{"key":"Music","value":"Pressocup_Birthday_Music.aac"},{"key":"XMPieRecipientKey","value":"0390acbf94ac31076f2fef769498ae1e"},{"key":"userId","value":"XMPMarketing"},{"key":"password","value":"Marketing2019"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"body\": \"{\\\"status\\\":\\\"OK\\\",\\\"project\\\":\\\"CD752E803F894565887A6D4089DEE154\\\",\\\"contentId\\\":\\\"11d8a3a0-0077-11ea-902c-a36a50acf874\\\",\\\"videoKey\\\":\\\"665a0093fe8f084b4cbfa10edb4bd389fca2cdded163ab94a48d64705530e58c9ef69bb22ff73c22b799f6d40ec0ef3df5cd49b5ada20dbc5e1d9f6056c435fa\\\",\\\"videoReady\\\":false,\\\"recordId\\\":\\\"John\\\"}\"\r\n}"}],"_postman_id":"92f9a241-ddcc-4967-b2fc-b169666bae6a"},{"name":"Async generate video","event":[{"listen":"prerequest","script":{"id":"d7160d06-3408-4097-831b-94fffff57c73","exec":["let guserName = pm.globals.get(\"guserName\");","let gpassword = pm.globals.get(\"gpassword\");","pm.variables.set(\"customer\",\"customerXMPie\");","pm.variables.set(\"project\",\"CD752E803F894565887A6D4089DEE154\");","pm.variables.set(\"userId\",guserName);","pm.variables.set(\"password\",gpassword);","pm.variables.set(\"parameters\",\"{ \t\\\"Coffee Brand Image\\\": \\\"medium roast-French Blend.png\\\", \t\\\"Coffee Brand Name\\\": \\\"French Blend\\\", \t\\\"Color\\\": \\\"DC5AC1\\\", \t\\\"Event\\\": \\\"Birthday\\\", \t\\\"Event Footage\\\": \\\"Baloons_Smaller.mp4\\\", \t\\\"FirstName\\\": \\\"John\\\", \t\\\"LastName\\\": \\\"Doe\\\", \t\\\"Music\\\": \\\"Pressocup_Birthday_Music.aac\\\", \t\\\"Recipient Name\\\": \\\"John\\\", \t\\\"Sender Free Text\\\": \\\"Hello\\\", \t\\\"Sender Name\\\": \\\"Jane\\\", \t\\\"XMPieRecipientKey\\\": \\\"1234561234567890\\\" }\");","pm.variables.set(\"thumbnails\",\"[\\\"Thumb1.jpg\\\",\\\"Thumb2.jpg\\\"]\");"],"type":"text/javascript"}}],"id":"237efaef-9b40-46b4-bd13-b43aea786917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"userId","value":"{{userId}}","description":"Video service username
\n","type":"text"},{"key":"password","value":"{{password}}","description":"Video service password
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"/* Tags required by the video template for example: { \\\"name\\\":\\\"John\\\" } */\":\"\",\r\n\t\"parameters\":{{parameters}},\t\r\n\t \"/* Array of Urls for video preview thumbnails for example: [\\\"//mysite.com/image1.jpg\\\"] */\":\"\",\r\n\t\"Thumbnail\":{{thumbnails}}\r\n}"},"url":"https://api.xcontentcloud.com/v1/video/:customer/:project","description":"Body is a set of two types of data:\nparameters are a set of string key values such as:\n\"name\":\"John\"\nThumbnail is an array of images to be shown as a video preview.
\n","urlObject":{"protocol":"https","path":["v1","video",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"890354a4-e28c-4b5d-be5d-121fc00954a0","name":"Async generate video","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"userId","value":"{{userId}}","description":"Video service username","type":"text"},{"key":"password","value":"{{password}}","description":"Video service password","type":"text"}],"body":{"mode":"raw","raw":"{\n \"parameters\": { \n \"Coffee Brand Image\": \"medium roast-French Blend.png\",\n \"Coffee Brand Name\": \"French Blend\",\n \"Color\": \"DC5AC1\",\n \"Event\": \"Birthday\",\n \"Event Footage\": \"Baloons_Smaller.mp4\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Music\": \"Pressocup_Birthday_Music.aac\",\n \"Recipient Name\": \"John\",\n \"Sender Free Text\": \"Hello\",\n \"Sender Name\": \"Jane\",\n \"XMPieRecipientKey\": \"1234561234567890\"\n },\n \"Thumbnail\": [\n \"thumb1.jpg\",\n \"Thumb2.jpg\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.xcontentcloud.com/v1/video/customerXMPie/CD752E803F894565887A6D4089DEE154"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"352"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 24 Nov 2019 11:57:05 GMT"},{"key":"x-amzn-RequestId","value":"9fbaabb7-1b7d-4b9f-b0e3-59d64273ea61"},{"key":"x-amz-apigw-id","value":"DqZyGHIwoAMFiNw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5dda700d-25f67cb433bab89cdbad744a;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 42b75b2f786059fa572a801a0e071c32.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"Zu8Tk3WCwhDSNtd7r6QY30biqZ81eS_4hNB-DF39QASi3HDGrzMB1A=="}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"body\": \"{\\\"status\\\":\\\"OK\\\",\\\"project\\\":\\\"CD752E803F894565887A6D4089DEE154\\\",\\\"contentId\\\":\\\"88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5\\\",\\\"videoKey\\\":\\\"f6c3a9498e66d99c503ff5293ac50a1429a50eb1f6a0017717be0921bf2a9a55a269f0f5ba714c9ffe53f1273eb29a9dfc84b9e190588d1cd83997dc695cc00e\\\",\\\"videoReady\\\":false,\\\"recordId\\\":\\\"1234561234567890\\\"}\"\n}"}],"_postman_id":"237efaef-9b40-46b4-bd13-b43aea786917"},{"name":"Async get video status","event":[{"listen":"test","script":{"id":"78d7143e-d7be-4a08-a13b-55f2e01ed5f0","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"762cf2f3-98fd-4add-8937-8f8f2ee1a388","exec":["pm.variables.set(\"customer\",\"customerXMPie\");","pm.variables.set(\"project\",\"CD752E803F894565887A6D4089DEE154\");","pm.variables.set(\"contentId\",\"08a87220-0b8e-11ea-a195-fdedb8ffea0e\");"],"type":"text/javascript"}}],"id":"3cd96b9f-25d0-421f-b0cb-ae3dbf357741","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.xcontentcloud.com/v1/video/status/:customer/:project?contentId={{contentId}}","description":"Check if a video is rendered.
\n","urlObject":{"protocol":"https","path":["v1","video","status",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[{"key":"contentId","value":"{{contentId}}"}],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"59f5ca58-da22-410f-9aa5-312052a1f6d8","name":"Async get video status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.xcontentcloud.com/v1/video/status/customerXMPie/CD752E803F894565887A6D4089DEE154?contentId=88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","video","status","customerXMPie","CD752E803F894565887A6D4089DEE154"],"query":[{"key":"contentId","value":"88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5","description":"The content ID returned by the get/generate video methods"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 24 Nov 2019 12:01:15 GMT"},{"key":"x-amzn-RequestId","value":"0643f983-9ed6-47d8-8ac1-b02dab7c0a7b"},{"key":"x-amz-apigw-id","value":"DqaZmFs_IAMF1tQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5dda710a-47adb3a5df43c380aee371a0;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f98f465ca5f7e28aad47b7480dfd5061.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"5n8xJN4RSt-Hot9CKOMLdNtutJsT6Hw1MgNXFeiqoSF3CikD_4zBVA=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"contentId\": \"88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5\",\n \"videoReady\": false,\n \"recordId\": \"1234561234567890\"\n}"},{"id":"ca9463b1-a00f-4d77-a364-5e2f759b2973","name":"Async get video status - ready","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.xcontentcloud.com/v1/video/status/customerXMPie/CD752E803F894565887A6D4089DEE154?contentId=88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","video","status","customerXMPie","CD752E803F894565887A6D4089DEE154"],"query":[{"key":"contentId","value":"88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5","description":"The content ID returned by the get/generate video methods"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"256"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 24 Nov 2019 12:27:06 GMT"},{"key":"x-amzn-RequestId","value":"addfba74-11e9-4efd-af3f-898550fdc4ee"},{"key":"x-amz-apigw-id","value":"DqeL8HkboAMFpuA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5dda7719-69b60218df169a60af2c88c8;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a0dfc1e576cc19daa2f4d5ec699792f4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"hWKvCaW20YjJYj6g9qeMoKXdh0aUCElMju0J0rf6VLYNaZNS1jxkxA=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"movieUrl\": \"https://xmpvs-prd-movies-s3-v1-0-0-us-east-1.s3.amazonaws.com/XMPMarketing/CD752E803F894565887A6D4089DEE154/1234561234567890.mp4\",\n \"contentId\": \"88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5\",\n \"videoReady\": true,\n \"recordId\": \"1234561234567890\"\n}"}],"_postman_id":"3cd96b9f-25d0-421f-b0cb-ae3dbf357741"},{"name":"Async get video by content ID","event":[{"listen":"prerequest","script":{"id":"10eebfdc-76a4-41e8-a312-c72c35bcca51","exec":["pm.variables.set(\"customer\",\"customerXMPie\");","pm.variables.set(\"project\",\"CD752E803F894565887A6D4089DEE154\");","pm.variables.set(\"contentId\",\"08a87220-0b8e-11ea-a195-fdedb8ffea0e\");"],"type":"text/javascript"}}],"id":"9e2e9ee7-261c-42b6-af1e-9ed03e187638","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.xcontentcloud.com/v1/video/stream/:customer/:project?contentId={{contentId}}","description":"Get a posted video by its VideoID.\nThis method returns a video stream if rendering completes in 10 seconds. Otherwise it returns the same result as the post action.
\n","urlObject":{"protocol":"https","path":["v1","video","stream",":customer",":project"],"host":["api","xcontentcloud","com"],"query":[{"key":"contentId","value":"{{contentId}}"}],"variable":[{"description":{"content":"Customer ID
\n","type":"text/plain"},"type":"string","value":"{{customer}}","key":"customer"},{"description":{"content":"Project ID
\n","type":"text/plain"},"type":"string","value":"{{project}}","key":"project"}]}},"response":[{"id":"27c2cdb9-635a-492c-9a2d-b23eaa1d8f33","name":"Async get video by content ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.xcontentcloud.com/v1/video/stream/customerXMPie/CD752E803F894565887A6D4089DEE154?contentId=88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5","protocol":"https","host":["api","xcontentcloud","com"],"path":["v1","video","stream","customerXMPie","CD752E803F894565887A6D4089DEE154"],"query":[{"key":"contentId","value":"88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5","description":"The content ID returned by the get/generate video methods"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"302"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Sun, 24 Nov 2019 12:05:30 GMT"},{"key":"x-amzn-RequestId","value":"65120203-a098-4ad3-bcf8-19af7d4e48df"},{"key":"x-amz-apigw-id","value":"Dqa_mHG-IAMFTtg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5dda71fd-4c1f31788a9e2470146a0d08;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 f98f465ca5f7e28aad47b7480dfd5061.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"TLV50-C1"},{"key":"X-Amz-Cf-Id","value":"-QLdJcVIk0WXl-B_RAcEjD_2ii9jRcgWI4unc2fNJJWQ9MMFrS_icw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"project\": \"CD752E803F894565887A6D4089DEE154\",\n \"contentId\": \"88eec0d0-0eb1-11ea-95b5-05d7e00fe3e5\",\n \"videoKey\": \"4af4b384af4feed283102c1105c2d6e827deb86d426cdcbfa39de9335066a3a31687eb07b2e88f3042961c0257fc5ec297d1091d9efe49a0960ad142ae80831d\",\n \"videoReady\": false,\n \"recordId\": \"1234561234567890\"\n}"}],"_postman_id":"9e2e9ee7-261c-42b6-af1e-9ed03e187638"}],"id":"840eec0e-b40e-4fe8-9e52-463ca31e1525","_postman_id":"840eec0e-b40e-4fe8-9e52-463ca31e1525","description":""}],"id":"7a593c09-7f27-4500-b15f-a37537b5ed44","description":"API version 1.0
\n","_postman_id":"7a593c09-7f27-4500-b15f-a37537b5ed44"}],"event":[{"listen":"prerequest","script":{"id":"237d1c99-4427-4ddb-bf23-9179df6266f9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"60168490-c8df-4105-8336-82b7612683ee","type":"text/javascript","exec":[""]}}]}