{"info":{"_postman_id":"baaddadb-397c-41f2-86dd-511eaf0e30e5","name":"DCA Developer Documentation","description":"# Introduction\nDCA provides users with an API to convert files from your computer, files that you can access using Web protocols (SFTP, FTP, HTTP) or using your remote storage accounts (Amazon S3 and Azure). Our APIs are fast, reliable, scalable and easy to use!\n\nThe following documentation shows how to use API and get starter quick and without any issues. Shall you have any questions about anything that is not covered by this topic, please check our FAQ page or contact us at info@docconversionapi.com.\n\nTo start using our API you will need to [sign up for an account](https://app.docconversionapi.com/#/createaccount) first.\n\n# Getting started\nTo convert a file to any available format you just need to perform following actions:\n1. Get an API Key + Secret.\n2. Trigger a conversion process.\n3. Download the result to your local or remote folder.\n\n## Getting an API Key/Secret\nFor every request that you make to DCA API you must have a Key and Secret to be able to authenticate. If you have already [signed up for an account](https://app.docconversionapi.com/#/createaccount), you can find and copy your Key/Secret values on [API Applications page](https://app.docconversionapi.com/#/applications).\n\nLet's look at an example of a simple call to our API to get the status.\n\n## Node.js\n\n\t\tvar request = require('request');\n\t    \n\t\trequest.post({\n\t\t   url:'https://api.docconversionapi.com/status'\n\t\t\t}, function (err, response) {\n\t\t    if (err) {\n\t\t    \tconsole.log(err);\n\t\t    } else {\n\t\t    \tconsole.log(response.body);\n\t\t    }\n\t\t});\n\n## JSON Response example\n\n\t{\n\t    \"statusCode\": \"Down\",\n\t    \"authStatus\": \"Invalid\",\n\t    \"services\": [\n\t        {\n\t            \"name\": \"DocBot\",\n\t            \"statusCode\": \"OK\",\n\t            \"errorMessage\": null\n\t        }\n\t    ]\n\t}\n\n# Error Handling and Prevention\n\n# Error Codes\nError message will always look like this so you can design your app to handle different types of error in an appropriate way.\n\n~~~\n{\n   \"errors\":[\n      {\n         \"code\":\"an_error_code\",\n         \"message\":\"Some error message\",\n         \"logId\":1234\n      }\n   ]\n}\n~~~\n\nExample error codes:\n\n|HTTP Status Code |Error Code |Message \n|--  |--   |--\n|400 |2001 | Validation error\n|500 |2002 | Document opening error\n|500 |2003 | Document handling error\n|500 |2004 | Document saving error\n|500 |9999 | Validation error\n\nHere you can see possible error messages and their reasons:\n\n|Error Code |Message | Reason\n|--  |-- |--\n||inputFile is missing in the request body |Please include 'inputFile' into request\n||file is provided but it's empty (file size is 0 bytes)|inputFile' is empty\n||input file extension is not in allowed extensions list (see above)|inputFile' extension is not supported\n||outputFormat value is not in allowed extensions list (see above)|outputFormat' isn't supported\n||optionsJson value is not a valid JSON string|Invalid 'optionsJson'\n||'pages' parameter in optionsJson has invalid value|Invalid value provided for 'pages' parameter\n||'width' and/or 'height' values are above 500%|Requested image dimensions are too large, please reduce the dimensions and try again.\n||unit specified for 'height' parameter is neither 'px' nor '%'|Unsupported units used for height.\n||value of 'height' parameter is not a number/negative number/not number at all|Invalid value provided for 'height' parameter\n||unit specified for 'width' parameter is neither 'px' nor '%'|Unsupported units used for width.`\n||value of 'width' parameter is not a number/negative number/not number at all|Invalid value provided for 'width' parameter\n||value of 'pdfType' parameter is not in allowed types list|Invalid value provided for 'pdfType' parameter`\n||value of 'orientation' parameter is neither 'portrait' nor 'landscape'|Invalid value provided for 'orientation' parameter","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Common API Reference","item":[{"name":"status","event":[{"listen":"test","script":{"id":"dd16963a-e22e-4868-8563-035033ca82d8","type":"text/javascript","exec":[""]}}],"id":"21b7ef45-4b81-487e-ad77-ca14901ead3b","request":{"auth":{"type":"noauth"},"method":"GET","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{serverDomain}}/status","description":"This API simply checks the status of the service and returns a simple response confirming if the service is available and the API Key used is correct.\n\nSo there are two possible responses, both with a HTTP status of 200:\n\n~~~\nHTTP 200\n{\n   \"status\":\"OK\",\n   \"authorisation\":\"valid\"\n}\n~~~\n\nOR, if the call to `status` does not include authorization:\n~~~\nHTTP 200\n{\n   \"status\":\"OK\",\n   \"authorisation\":\"invalid\"\n}\n~~~"},"response":[],"_postman_id":"21b7ef45-4b81-487e-ad77-ca14901ead3b"},{"name":"available conversion formats","event":[{"listen":"test","script":{"id":"dd16963a-e22e-4868-8563-035033ca82d8","exec":[""],"type":"text/javascript"}}],"id":"a45cae1c-21a3-41be-9f03-2be027d11ce0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth"},"method":"GET","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}","description":"Application ID header"},{"key":"X-SecretKey","value":"{{X-SecretKey}}","description":"Secret key header"}],"url":"{{serverDomain}}/convert/availableFormats","description":"This API simply returns key/value set where key is the name of the input format and value is the list of all available output formats for the input format.\n\nSo there is one possible response with 200 status code:\n\n~~~\nHTTP 200\n{\n    \"doc\": [\n        \"pdf\",\n        \"doc\",\n        \"docx\",\n        \"rtf\",\n        \"odt\",\n        \"svg\",\n        \"html\",\n        \"mhtml\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"htm\"\n    ],\n    \"docx\": [\n        \"pdf\",\n        \"doc\",\n        \"docx\",\n        \"rtf\",\n        \"odt\",\n        \"svg\",\n        \"html\",\n        \"mhtml\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"htm\"\n    ],\n    \"odt\": [\n        \"pdf\",\n        \"doc\",\n        \"docx\",\n        \"rtf\",\n        \"odt\",\n        \"svg\",\n        \"html\",\n        \"mhtml\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"htm\"\n    ],\n    \"rtf\": [\n        \"pdf\",\n        \"doc\",\n        \"docx\",\n        \"rtf\",\n        \"odt\",\n        \"svg\",\n        \"html\",\n        \"mhtml\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"htm\"\n    ],\n    \"txt\": [\n        \"pdf\",\n        \"doc\",\n        \"docx\",\n        \"rtf\",\n        \"odt\",\n        \"svg\",\n        \"html\",\n        \"mhtml\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"htm\"\n    ],\n    \"xls\": [\n        \"pdf\",\n        \"svg\",\n        \"html\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"csv\",\n        \"xls\",\n        \"xlsx\",\n        \"ods\"\n    ],\n    \"xlsx\": [\n        \"pdf\",\n        \"svg\",\n        \"html\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"csv\",\n        \"xls\",\n        \"xlsx\",\n        \"ods\"\n    ],\n    \"ods\": [\n        \"pdf\",\n        \"svg\",\n        \"html\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"csv\",\n        \"xls\",\n        \"xlsx\",\n        \"ods\"\n    ],\n    \"html\": [\n        \"pdf\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\"\n    ],\n    \"htm\": [\n        \"pdf\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\"\n    ],\n    \"csv\": [\n        \"pdf\",\n        \"svg\",\n        \"html\",\n        \"txt\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"csv\",\n        \"xls\",\n        \"xlsx\",\n        \"ods\"\n    ],\n    \"ppt\": [\n        \"pdf\",\n        \"ppt\",\n        \"pptx\",\n        \"html\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"svg\",\n        \"tiff\",\n        \"tif\"\n    ],\n    \"pptx\": [\n        \"pdf\",\n        \"ppt\",\n        \"pptx\",\n        \"html\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"svg\",\n        \"tiff\",\n        \"tif\"\n    ],\n    \"odp\": [\n        \"pdf\",\n        \"ppt\",\n        \"pptx\",\n        \"html\",\n        \"jpeg\",\n        \"jpg\",\n        \"png\",\n        \"bmp\",\n        \"svg\",\n        \"tiff\",\n        \"tif\"\n    ],\n    \"bmp\": [\n        \"pdf\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"docx (Beta)\",\n        \"doc (Beta)\"\n    ],\n    \"jpeg\": [\n        \"pdf\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"docx (Beta)\",\n        \"doc (Beta)\"\n    ],\n    \"jpg\": [\n        \"pdf\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"docx (Beta)\",\n        \"doc (Beta)\"\n    ],\n    \"png\": [\n        \"pdf\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"docx (Beta)\",\n        \"doc (Beta)\"\n    ],\n    \"tiff\": [\n        \"pdf\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"docx (Beta)\",\n        \"doc (Beta)\"\n    ],\n    \"tif\": [\n        \"pdf\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"docx (Beta)\",\n        \"doc (Beta)\"\n    ],\n    \"pdf\": [\n        \"pdf\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\",\n        \"docx (Beta)\",\n        \"doc (Beta)\"\n    ],\n    \"msg\": [\n        \"msg\",\n        \"eml\",\n        \"pdf\",\n        \"html\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\"\n    ],\n    \"eml\": [\n        \"msg\",\n        \"eml\",\n        \"pdf\",\n        \"html\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\"\n    ],\n    \"emlx\": [\n        \"msg\",\n        \"eml\",\n        \"pdf\",\n        \"html\",\n        \"jpg\",\n        \"jpeg\",\n        \"png\",\n        \"bmp\",\n        \"tiff\",\n        \"tif\"\n    ]\n}\n~~~"},"response":[],"_postman_id":"a45cae1c-21a3-41be-9f03-2be027d11ce0"},{"name":"user credit balance","event":[{"listen":"test","script":{"id":"dd16963a-e22e-4868-8563-035033ca82d8","exec":[""],"type":"text/javascript"}}],"id":"0afd6ac8-d825-4820-9db6-d95472b634cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth"},"method":"GET","header":[{"description":"Authentication header must be provided in order to get credit information for the user","key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"description":"Authentication header must be provided in order to get credit information for the user","key":"X-SecretKey","value":"{{X-SecretKey}}"}],"url":"{{serverDomain}}/status/credit_balance","description":"This API simply checks the credit balance for the user showing how many credits are left to use for this user. The value is calculated based on the following formula creditLeftToUse = (initially available credits - credits used by this user).\n\nSo there is one possible response with 200 status code.\n\n~~~\nHTTP 200\n{\n    \"creditLeftToUse\": 239\n}\n~~~\n\nNOTE: Response value is test in this case and can be different for different users."},"response":[],"_postman_id":"0afd6ac8-d825-4820-9db6-d95472b634cc"}],"id":"567e5226-062e-413f-ae9a-6b249f0a236e","description":"These are API resources which work across all our APIs in the same way.","_postman_id":"567e5226-062e-413f-ae9a-6b249f0a236e"},{"name":"ConvertBot","item":[{"name":"REST API Reference","item":[{"name":"convert","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"fdf4fa3a-c0f9-91b5-c65a-3326e5e22fb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"JSON String containing any additional options relevant to the conversion type. If \"inputFileFormat\" property is set to \"html\" and a link to the page is provided it (the page) will be converted to PDF.\n\nList of available options and their values:\n1. \"pdfType\": 1A, 1B etc. - for PDF only\n2. \"orientation\": landscape, portrait(default)\n3. \"pages\": 1, 2, 3 etc\n4. \"width\": 100%, 90% etc\n5. \"height\": 100%, 90% etc\n6. \"autoSizeColumns\": true, false - for EXCEL files only\n7. \"displayGridlines\": true, false - for EXCEL files only\n8. \"securePdf\": true, false - for PDF only\n9. \"ownerPassword\": (string) - for PDF only\n10. \"userPassword\": (string) - for PDF only","key":"optionsJSON","type":"text","value":"{}"},{"key":"inputFile","sessionValue":{"0":{}},"type":"file","src":"/C:/Users/roman/Desktop/1-13-2020-testhtml.docx"},{"key":"performAsync","value":"true","type":"text","disabled":true}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PDF","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PDF"}]},"description":"Convert files from one format to another.  You can convert files by uploading them in the body of your request or from a public URI or private \"storage://\" account by setting up a link to it in your account.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter.  Convert also supports some options from other APIs such as editing/removing metadata or protecting your files.\n\nYou can provide additional options to convert a file without file extension. Also you can provide viewerOptions in case you want to get a Viewer link to be able to browse your file with Viewer Tool in your browser. By default all viewer options are set to \"False\". In case you do not provide viewerOptions you will get a file as a result."},"response":[],"_postman_id":"fdf4fa3a-c0f9-91b5-c65a-3326e5e22fb1"},{"name":"convert PDF to DOC","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"733d32d3-b7b1-4f86-89e4-09aab9043019","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"JSON String containing any additional options relevant to the conversion type. If \"inputFileFormat\" property is set to \"html\" and a link to the page is provided it (the page) will be converted to PDF.\n\nList of available options and their values:\n1. \"pdfType\": 1A, 1B etc. - for PDF only\n2. \"orientation\": landscape, portrait(default)\n3. \"pages\": 1, 2, 3 etc\n4. \"width\": 100%, 90% etc\n5. \"height\": 100%, 90% etc\n6. \"autoSizeColumns\": true, false - for EXCEL files only\n7. \"displayGridlines\": true, false - for EXCEL files only\n8. \"securePdf\": true, false - for PDF only\n9. \"ownerPassword\": (string) - for PDF only\n10. \"userPassword\": (string) - for PDF only","key":"optionsJSON","type":"text","value":"{}"},{"key":"inputFile","sessionValue":{"0":{}},"type":"file","value":null}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=DOC","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"DOC"}]},"description":"Convert files from one format to another.  You can convert files by uploading them in the body of your request or from a public URI or private \"storage://\" account by setting up a link to it in your account.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter.  Convert also supports some options from other APIs such as editing/removing metadata or protecting your files.\n\nYou can provide additional options to convert a file without file extension. Also you can provide viewerOptions in case you want to get a Viewer link to be able to browse your file with Viewer Tool in your browser. By default all viewer options are set to \"False\". In case you do not provide viewerOptions you will get a file as a result."},"response":[],"_postman_id":"733d32d3-b7b1-4f86-89e4-09aab9043019"},{"name":"async convert result","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","type":"text/javascript","exec":[""]}}],"id":"e5774d4e-a32a-e3ef-9e5b-510b3184dfe4","request":{"auth":{"type":"noauth"},"method":"GET","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"JSON String containing any additional options relevant to the conversion type. If \"inputFileFormat\" property is set to \"html\" and a link to the page is provided it (the page) will be converted to PDF.\n\nList of available options and their values:\n1. \"pdfType\": 1A, 1B etc. - for PDF only\n2. \"orientation\": landscape, portrait(default)\n3. \"pages\": 1, 2, 3 etc\n4. \"width\": 100%, 90% etc\n5. \"height\": 100%, 90% etc\n6. \"autoSizeColumns\": true, false - for EXCEL files only\n7. \"displayGridlines\": true, false - for EXCEL files only\n8. \"securePdf\": true, false - for PDF only\n9. \"ownerPassword\": (string) - for PDF only\n10. \"userPassword\": (string) - for PDF only","key":"optionsJSON","type":"text","value":"{\"pdfType\":\"1A\"}"},{"key":"inputFile","sessionValue":{"0":{}},"type":"file","value":null}]},"url":{"raw":"{{serverDomain}}/convert/result?guid={{guid}}","host":["{{serverDomain}}"],"path":["convert","result"],"query":[{"key":"guid","value":"{{guid}}"}]},"description":"Convert files from one format to another.  You can convert files by uploading them in the body of your request or from a public URI or private \"storage://\" account by setting up a link to it in your account.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter.  Convert also supports some options from other APIs such as editing/removing metadata or protecting your files.\n\nYou can provide additional options to convert a file without file extension. Also you can provide viewerOptions in case you want to get a Viewer link to be able to browse your file with Viewer Tool in your browser. By default all viewer options are set to \"False\". In case you do not provide viewerOptions you will get a file as a result."},"response":[],"_postman_id":"e5774d4e-a32a-e3ef-9e5b-510b3184dfe4"},{"name":"convert remote resource","id":"0908a7eb-a75b-3e53-31fc-c7ae0a731cd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"optionsJSON","value":"{}","description":"JSON String containing any additional options relevant to the conversion type. If \"inputFileFormat\" property is set to \"html\" and a link to the page is provided it (the page) will be converted to PDF.\n\nList of available options and their values:\n1. \"pdfType\": 1A, 1B etc. - for PDF only\n2. \"orientation\": landscape, portrait(default)\n3. \"pages\": 1, 2, 3 etc\n4. \"width\": 100%, 90% etc\n5. \"height\": 100%, 90% etc\n6. \"autoSizeColumns\": true, false - for EXCEL files only\n7. \"displayGridlines\": true, false - for EXCEL files only\n8. \"securePdf\": true, false - for PDF only\n9. \"ownerPassword\": (string) - for PDF only\n10. \"userPassword\": (string) - for PDF only","type":"text"},{"key":"inputFile","sessionValue":{"0":{}},"description":"inputFile string which represents the location of the remote resource. The format should be following: \"storage://{linkedStorageName(local)}/bucketName/pathToTheResource\".","type":"text","value":"http://test.travelitinerary.net/?UUID=77FF53F8-9E64-4B00-9002-3076CCCD9BD2&print=1"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=DOCX","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"DOCX"}]},"description":"Convert files from one format to another.  You can convert files by uploading them in the body of your request or from a public URI or private \"storage://\" account by setting up a link to it in your account.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter.  Convert also supports some options from other APIs such as editing/removing metadata or protecting your files.\n\nYou can provide additional options to convert a file without file extension. Also you can provide viewerOptions in case you want to get a Viewer link to be able to browse your file with Viewer Tool in your browser. By default all viewer options are set to \"False\". In case you do not provide viewerOptions you will get a file as a result."},"response":[],"_postman_id":"0908a7eb-a75b-3e53-31fc-c7ae0a731cd3"},{"name":"viewer","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","type":"text/javascript","exec":[""]}}],"id":"1ef151a1-876a-4bf8-ad0e-7e0d20b3b8c7","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"viewerOptions","value":"{\"thumbnails\":\"true\", \"properties\":\"true\", \"zoom\":\"true\", \"rotate\":\"true\", \"enableHandTool\":\"true\"}","description":"JSON String containing any additional options relevant to the viewer tool.","type":"text"},{"key":"saveTo","value":"storage://ProductionFiles/documentconversionapi/1958/viewerExample123.docx","sessionValue":"storage://","description":"Path to the remote file storage containing information in the next format:\nstorage://\"name of the storage in the DB\"/\"bucket or folder name\"/\"full path to the file including name and extension\"","type":"text"},{"key":"file","value":null,"sessionValue":{"0":{}},"description":"File to be used in Viewer","type":"file"},{"key":"optionsJson","value":"{}","type":"text"}]},"url":"{{serverDomain}}/viewer","description":"Returns Viewer URL. It allows user to display a pdf file in a Viewer tool inside browser.\n\nYou can provide additional options to handle your viewer options."},"response":[],"_postman_id":"1ef151a1-876a-4bf8-ad0e-7e0d20b3b8c7"},{"name":"convert HTML page*","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","type":"text/javascript","exec":[""]}}],"id":"5b9ba08d-b3ee-47d6-86f3-961925a7bea6","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":"https://www.w3schools.com","description":"URL of the website to be converted.","type":"text"},{"key":"optionsJSON","value":"{\"isScreenshot\":\"true\"}","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"},{"key":"viewerOptions","value":"","type":"text","disabled":true},{"key":"inputFileFormat","value":"html","description":"Manual format property. Should always be included in case if website URL does not contain .htm or .html extension at the end","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PDF","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PDF"}]},"description":"Convert files from one format to another.  You can convert files by uploading them in the body of your request or from a public URI or private \"storage://\" account by setting up a link to it in your account.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter.  Convert also supports some options from other APIs such as editing/removing metadata or protecting your files.\n\nYou can provide additional options to convert a file without file extension. Also you can provide viewerOptions in case you want to get a Viewer link to be able to browse your file with Viewer Tool in your browser. By default all viewer options are set to \"False\". In case you do not provide viewerOptions you will get a file as a result."},"response":[],"_postman_id":"5b9ba08d-b3ee-47d6-86f3-961925a7bea6"},{"name":"metadata","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","type":"text/javascript","exec":[""]}}],"id":"6fe96bd9-62ea-4a9b-b16e-2b621119faf5","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"title\": \"title\", \"author\":\"new-author\", \"keywords\":\"new-keywords\", \"status\":\"new-status\", \"subject\":\"new-subject\"}","description":"JSON String containing any additional options relevant to the metadata","type":"text"}]},"url":"{{serverDomain}}/metadata/edit","description":"Edits or removes the metadata of an existing file.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"6fe96bd9-62ea-4a9b-b16e-2b621119faf5"},{"name":"protect","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"8e0ac1ab-5b36-4e03-9ed7-615a7d5fabb5","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","description":"This is the file to be converted to the output format.","type":"file","value":null},{"key":"optionsJSON","value":"{\"ownerPassword\":\"123456\", \"userPassword\":\"9728f894-0c70-4130-8507-1340d2291303\", \"allowedActions\":\"print,modify,copy,annotate,forms\"}","description":"JSON String containing any additional options relevant to the Pdf security information","type":"text"}]},"url":"{{serverDomain}}/metadata/protectPdf","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"8e0ac1ab-5b36-4e03-9ed7-615a7d5fabb5"},{"name":"sign pdf","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"837660bc-2c21-48c0-93b3-5ef88d861bd1","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"text","value":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"},{"description":"JSON String containing any additional options relevant to the Pdf security information","key":"optionsJSON","type":"text","value":"{\n\"signatureX\":\"400\",\n\"signatureY\":\"0\",\n\"signatureWidth\":\"180\",\n\"signatureHeight\":\"140\",\n\"reason\":\"Test signature\",\n\"contact\":\"www.docconversionapi.com\",\n\"signerLocation\":\"www.docconversionapi.com\",\n\"visible\":\"true\",\n\"certificatePassword\":\"123Err\"\n}"},{"key":"signatureAppearance","type":"text","value":"https://app.docconversionapi.com/img/docConversionAPI.svg"},{"key":"certificate","type":"file","value":null}]},"url":"{{serverDomain}}/sign","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"837660bc-2c21-48c0-93b3-5ef88d861bd1"},{"name":"document word count","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"a2f808de-57d5-47b2-a50a-f20a2b4f7022","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"file","value":null},{"description":"JSON String containing any additional options","key":"optionsJSON","type":"text","value":"{}"}]},"url":"{{serverDomain}}/utility/wordcount","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"a2f808de-57d5-47b2-a50a-f20a2b4f7022"},{"name":"document text replace","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"561470d9-c16c-4b9b-886e-22feeb2dfe69","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"file","value":null},{"description":"JSON String containing any additional options relevant to the find and replace text capability for MS Word documents","key":"optionsJSON","type":"text","value":"{\"searchItems\": \"The Guide\", \"replaceItems\": \"new-text\", \"matchCase\": \"true\", \"matchWholeWord\": \"false\"}"}]},"url":"{{serverDomain}}/utility/replace","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"561470d9-c16c-4b9b-886e-22feeb2dfe69"},{"name":"document characters count","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"93c5a151-896f-4093-9014-44beee95defb","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"text","value":"https://www.chikrii.com/products/tex2word/samples/sample.doc"},{"description":"JSON String containing any additional options relevant to the find and replace text capability for MS Word documents","key":"optionsJSON","type":"text","value":"{}"}]},"url":"{{serverDomain}}/utility/characters","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"93c5a151-896f-4093-9014-44beee95defb"},{"name":"document paragraphs count","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"416454c8-cefc-4edc-b6b8-def46cd2ff14","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"file","value":null},{"description":"JSON String containing any additional options relevant to the find and replace text capability for MS Word documents","key":"optionsJSON","type":"text","value":"{}"}]},"url":"{{serverDomain}}/utility/paragraphs","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"416454c8-cefc-4edc-b6b8-def46cd2ff14"},{"name":"document pages count","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"82948603-6f6d-442f-831f-9312aebfa37d","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"file","value":null},{"description":"JSON String containing any additional options relevant to the find and replace text capability for MS Word documents","key":"optionsJSON","type":"text","value":"{\"searchItems\": \"The Guide\", \"replaceItems\": \"new-text\", \"matchCase\": \"true\", \"matchWholeWord\": \"false\"}"}]},"url":"{{serverDomain}}/utility/replace","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"82948603-6f6d-442f-831f-9312aebfa37d"},{"name":"template merge","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"f108fe62-5b1d-4c84-b388-6f862c3e85c0","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"file","value":null},{"description":"JSON String containing any additional options relevant to the find and replace text capability for MS Word documents","key":"DataJson","type":"text","value":""}]},"url":"{{serverDomain}}/assembly/merge","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"f108fe62-5b1d-4c84-b388-6f862c3e85c0"},{"name":"template validate","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"6f7b6bfb-9327-4fda-a484-7583c74cb420","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"file","value":null},{"description":"JSON String containing any additional options relevant to the find and replace text capability for MS Word documents","key":"DataJson","type":"text","value":"{}"}]},"url":"{{serverDomain}}/assembly/validate","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"6f7b6bfb-9327-4fda-a484-7583c74cb420"},{"name":"template normalize","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"fe2c7240-de86-4a12-a168-28ec742dd52b","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"file","value":null},{"description":"JSON String containing any additional options relevant to the find and replace text capability for MS Word documents","key":"DataJson","type":"text","value":"{}"}]},"url":"{{serverDomain}}/assembly/normalize","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"fe2c7240-de86-4a12-a168-28ec742dd52b"},{"name":"template list fields","event":[{"listen":"test","script":{"id":"9f38327e-cc27-47b3-90cf-974a4fa88482","exec":[""],"type":"text/javascript"}}],"id":"f94ae578-c2e5-4da6-8a8e-c4a39e85997c","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"description":"This is the file to be converted to the output format.","key":"inputFile","type":"file","value":null},{"description":"JSON String containing any additional options relevant to the find and replace text capability for MS Word documents","key":"DataJson","type":"text","value":"{}"}]},"url":"{{serverDomain}}/assembly/list_fields","description":"Protects the content of an existing file with security options.  You can supply files either in the POST body, as a URI to a public file on the Internet, or as a \"storage://\" link to one of your linked storage accounts.  Exactly how the protection works will different depending on the type of source file used.\n\nAs with all our APIs the primary options can be set using optionsJSON body parameter."},"response":[],"_postman_id":"f94ae578-c2e5-4da6-8a8e-c4a39e85997c"}],"id":"ef0ff8c2-f9cc-4a32-972c-f332ba744979","description":"The following explains the top level REST end-points for the ConvertBot service.","event":[{"listen":"prerequest","script":{"id":"c1626146-cb86-4906-9965-bdb5c1786b2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"217f0a59-090c-48bc-982e-df9cd26a7dd7","type":"text/javascript","exec":[""]}}],"_postman_id":"ef0ff8c2-f9cc-4a32-972c-f332ba744979"},{"name":"Options JSON Reference","item":[],"id":"a9962491-53ce-4c36-9580-6beddb6fd8fe","description":"Most of our APIs accept a parameter called \"optionsJSON\" which is a JSON formatted list of options specific to the operation being performed.  Any options not supported are ignored.  For example the convert API supports options like \"pages\" to choose which pages should be converted, or \"fitToPage\" which removes the margins when converting a document page to an image.\n\nBelow is a summary of the main options which can of course be combined as required for multiple options.\n\nThe following is an example of valid optionsJSON parameter specifying the type of PDF file to be created and setting 'Fit To Page' to true:\n\n~~~\n{\"pdfType\" : \"1A\", \"fitToPage\" : true}\n~~~\n\n#### Options available for optionsJson parameter:\n\n#### Pages (type - string)\nThis parameter allows you to select which pages of document will be converted.\nIf this parameter isn't specified, or only first page requested, then result will be a single image, otherwise a ZIP archive with requested pages will be returned.\n\nPossible values:\n- \"all\" (case insensitive) - returns all pages as ZIP archive\n- \"1\" - returns first page as image\n- \"1,3,4,21\" - returns specified pages as ZIP archive\n\n#### Width/Height (type - string)\nThis one can be used to set output image size.\nIf only width or height is specified, then aspect ratio is kept.\nAffects only conversions to image. (*JPEG/PNG/PMP/TIFF*)\nYou must specify a number and optionally a unit, for example: *200%*, *500px* or *700*\n\nPossible dimensions:\n-   px (default)\n-   %\n\nIf unit not specified then px is used.\nMaximum value for % unit is 500.\n\n#### PdfType (type - string)\n\nWith this parameter you can choose type of output PDF.\nAffects only conversions to PDF.\n\nPossible values (case insensitive):\n- 1a\n- 1b\n- 2a\n- 2b\n- 15\n- 16\n- 17 *(default)*\n\nWord conversion supports 1a, 1b and default\nExcel conversion supports 1a, 1b and default\nPdf Conversion supports 1a and 1.5 (used as default for PowerPoint)\n\n#### Orientation (type - string)\n\nThis parameter changes orientation of source document's pages.\nFor PowerPoint it's important to specify \"landscape\" orientation if you want result file to look natural.\nAffects only DOC(X), XLS(X), PPT(X).\n\nPossible values:\n-   portrait (default)\n-   landscape\n\n#### FitToPage (type - boolean)\nStretches input document to fit output document width (if applicable).\nWith this parameters borders will be removed when possible.\nDefault value: `false`\n\n#### AutoSizeColumns (type - boolean)\nDetermines if columns in html file should be resized to fit it's content.\nAvailable only in Excel conversions.\nDefault value: `false`\n\n#### DisplayGridlines (type - boolean)\nDetermines if gridlines should be displayed in html file.\nAvailable only in Excel conversions.\nDefault value: `false`\n\n---\n\n#### Options available for outputFormat parameter:\n\n- PDF\n- DOC\n- DOCX\n- RTF\n- ODT\n- SVG\n- HTML\n- MHTML\n- TXT\n- JPG / JPEG\n- PNG\n- TIF / TIFF\n- XLS\n- XLSX\n- CSV\n- ODS\n- PPT\n- PPTX\n- ODP\n\n#### inputFile allowed extensions:\n\n- DOC, DOCX, ODT, RTF, TXT\n- XLS, XLSX, ODS, CSV\n- PPT, PPTX, ODP\n- JPG, JPEG, PNG, TIF, TIFF\n- HTML","event":[{"listen":"prerequest","script":{"id":"71429e80-c64c-45b3-bc5b-ae6bb8deaaa1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e171e35c-d8f8-4dde-ab9a-18ac6d764185","type":"text/javascript","exec":[""]}}],"_postman_id":"a9962491-53ce-4c36-9580-6beddb6fd8fe"},{"name":"Examples","item":[{"name":"Word","item":[{"name":"convert Word to PDF with pdf type and fit to page","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"29c73340-df9a-ce1d-e513-af42a8787f56","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pdfType\" : \"1B\", \"fitToPage\" : true}","description":"JSON String containing any additional options relevant to the conversion type. In this case PDF type will be PDF/1B and contents will fit to page.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=pdf","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"pdf"}]}},"response":[],"_postman_id":"29c73340-df9a-ce1d-e513-af42a8787f56"},{"name":"convert Word to PDF and get a viewer link","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"4b7564cb-fdfc-4f38-b1f4-e12f633c93c3","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pdfType\" : \"1B\", \"fitToPage\" : true}","description":"JSON String containing any additional options relevant to the conversion type. In this case PDF type will be PDF/1B and contents will fit to page.","type":"text"},{"key":"viewerOptions","value":"{\"thumbnails\":\"true\", \"properties\":\"true\", \"zoom\":\"true\", \"rotate\":\"true\", \"enableHandTool\":\"true\"}","sessionValue":"{\"thumbnails\":\"true\", \"properties\":\"true\", \"zoom\":\"true\", \"rotate\":\"true\", \"enableHandTool\":\"true\"}","description":"JSON String containing options for the PDF Viewer tool. If you want to get a Viewer link instead of a physical PDF file you have to include this option to your request.","type":"text"}]},"url":"{{serverDomain}}/viewer","description":"Whenever you convert a file you may provide a set of \"viewerOptions\".  By doing this rather than the response being a converted file, it will be a viewer link."},"response":[],"_postman_id":"4b7564cb-fdfc-4f38-b1f4-e12f633c93c3"},{"name":"convert Word to PDF with encryption (protected from editing, printing, etc.)","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"b0d92144-a841-443f-9915-392e270325cd","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pdfType\":\"1a\", \"securePdf\":\"true\", \"ownerPassword\":\"9728f894-0c70-4130-8507-1340d2291303\", \"allowedActions\":\"view\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case PDF type will be PDF/1A and protection/encryption is applied so it can only be viewed.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=pdf","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"pdf"}]}},"response":[],"_postman_id":"b0d92144-a841-443f-9915-392e270325cd"},{"name":"convert Word to HTML","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"317be0e6-8a70-75e1-4389-e0e68f0095fb","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=html","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"html"}]}},"response":[],"_postman_id":"317be0e6-8a70-75e1-4389-e0e68f0095fb"},{"name":"convert Word to SVG","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"ea55c473-9eec-60b9-1cf3-0223be1ba49f","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=svg","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"svg"}]}},"response":[],"_postman_id":"ea55c473-9eec-60b9-1cf3-0223be1ba49f"},{"name":"convert Word to JPEG all images","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"89cdfbde-2334-2a3f-6877-98af49e006dc","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pages\" : \"all\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case result will be an archive with all pages of the document.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=jpeg","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"jpeg"}]}},"response":[],"_postman_id":"89cdfbde-2334-2a3f-6877-98af49e006dc"},{"name":"convert Word to JPEG with resizing","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"410eac7f-43fc-64e5-3069-1f600fbb0993","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pages\" : \"1\", \"width\" : \"150%\", \"height\" : \"120%\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case result will be the resized first page.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=jpeg","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"jpeg"}]}},"response":[],"_postman_id":"410eac7f-43fc-64e5-3069-1f600fbb0993"},{"name":"convert Word to TIFF","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"9eac2bef-6f1b-0d86-2553-0d8f0dc9cf27","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=tiff","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"tiff"}]}},"response":[],"_postman_id":"9eac2bef-6f1b-0d86-2553-0d8f0dc9cf27"},{"name":"convert Word to Image with resizing","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"0799f61a-bac4-246c-3400-9cffa4a13512","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pages\" : \"1\", \"width\" : \"150%\", \"height\" : \"120%\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case result will be the resized first page.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=jpeg","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"jpeg"}]}},"response":[],"_postman_id":"0799f61a-bac4-246c-3400-9cffa4a13512"}],"id":"81745737-be71-5214-3a34-1cbc0659a710","_postman_id":"81745737-be71-5214-3a34-1cbc0659a710"},{"name":"Excel","item":[{"name":"convert Excel to PDF with pdf type","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"5e5e62b0-052b-5141-639a-41e2c1ade4d7","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pdfType\" : \"1B\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case PDF type will be PDF/1B.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PDF","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PDF"}]}},"response":[],"_postman_id":"5e5e62b0-052b-5141-639a-41e2c1ade4d7"},{"name":"convert Excel to PDF landscape","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"7aa464af-b05f-a279-f9b1-48ea17e315d8","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"orientation\" : \"landscape\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case PDF pages will have landscape orientation.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PDF","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PDF"}]}},"response":[],"_postman_id":"7aa464af-b05f-a279-f9b1-48ea17e315d8"},{"name":"convert Excel to BMP first page","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"7d2eb538-2335-7a67-09dd-7e6e5d911b6f","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pages\" : \"1\"}","description":"JSON String containing any additional options relevant to the conversion type. In this only first page will be returned.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=BMP","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"BMP"}]}},"response":[],"_postman_id":"7d2eb538-2335-7a67-09dd-7e6e5d911b6f"},{"name":"convert Excel to HTML with auto size columns and display gridlines","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"649bda19-4f7e-18f6-5cf7-abc5446f313e","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"autoSizeColumns\" : true, \"displayGridlines\" : true}","description":"JSON String containing any additional options relevant to the conversion type. In this example result will be the html file and columns will be resized to fit all content.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=HTML","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"HTML"}]}},"response":[],"_postman_id":"649bda19-4f7e-18f6-5cf7-abc5446f313e"}],"id":"93ac1100-588d-8cdf-8ac3-05a4adb82329","description":"Code example\n\t\t\t\t\n\t\t\t\tHttpClient client = new HttpClient();\n\n\t\t\t\tclient.Timeout = new TimeSpan(1, 10, 0);\n\t\t\t\tclient.DefaultRequestHeaders.Add(\"X-ApplicationID\", ConfigurationManager.AppSettings[\"ApplicationId\"]);\n\t\t\t\tclient.DefaultRequestHeaders.Add(\"X-SecretKey\", ConfigurationManager.AppSettings[\"SecretToken\"]);\n            \n\t\t\t\tvar inputPath = \"C:\\example.xls\";\n\t\t\t\tvar outputPath = \"C:\\example.pdf\";\n\t\t\t\tvar format = \"PDF\";\n\n\t\t\t\tusing (var fileStream = new FileStream(inputPath, FileMode.Open))\n                {\n                \tvar stream = new MemoryStream();\n                \tfileStream.CopyTo(stream);\n                        \n                \tstream.Seek(0, SeekOrigin.Begin);\n                        \n                \tcontent.Add(new StreamContent(stream), \"inputFile\", Path.GetFileName(inputPath));\n                        \n                \tcontent.Add(new StringContent(performAsync.ToString()), \"performAsync\");\n                \tcontent.Add(new StringContent(new JavaScriptSerializer().Serialize(parameters)),\n                                    \"optionsJson\");\n                }\n                    \n\t\t\t\tvar url = ConfigurationManager.AppSettings.Get(\"DCAAPIUrl\");\n\n                using (var request = new HttpRequestMessage(HttpMethod.Post, $\"{url}convert?outputFormat={format}\") { Content = content })\n                {\n                    request.Headers.TryAddWithoutValidation(\"Content-Type\", \"multipart/form-data\");\n\n                    var result = await client.SendAsync(request);\n                    result.EnsureSuccessStatusCode();\n                    \n                    using (var resultStream = await result.Content.ReadAsStreamAsync())\n                            {\n                                using (var outputStream = new FileStream(outputPath, FileMode.Create))\n                                \n                                {\n                                    resultStream.CopyTo(outputStream);\n                                }\n                            }\n                }","_postman_id":"93ac1100-588d-8cdf-8ac3-05a4adb82329"},{"name":"PowerPoint","item":[{"name":"convert PPT to PPTX","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"248bb171-029b-1b12-6447-13851d99d918","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PPTX","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PPTX"}]}},"response":[],"_postman_id":"248bb171-029b-1b12-6447-13851d99d918"},{"name":"convert PPT to SVG","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"af9cb093-3f49-2f14-7fac-491978af52ad","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=SVG","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"SVG"}]}},"response":[],"_postman_id":"af9cb093-3f49-2f14-7fac-491978af52ad"},{"name":"convert PPT to JPEG orientation","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"bcbcf9da-7d58-25d9-7288-cdd5c62263db","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"orientation\" : \"portrait\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case result will be the first page of presentation in portrait orientation.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=JPEG","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"JPEG"}]}},"response":[],"_postman_id":"bcbcf9da-7d58-25d9-7288-cdd5c62263db"}],"id":"07a41a64-1960-81fb-9930-3b5602b03983","_postman_id":"07a41a64-1960-81fb-9930-3b5602b03983"},{"name":"Images","item":[{"name":"convert TIFF to PNG specific pages","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"5164f39d-36a3-374c-6a56-9a5b5ee58538","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pages\" : \"1,2,3,4\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case result will be an archive with 1st,2nd,3rd and 4th pages of the document.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PNG","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PNG"}]}},"response":[],"_postman_id":"5164f39d-36a3-374c-6a56-9a5b5ee58538"},{"name":"convert TIFF to PDF specific pages copy","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"b429ca7c-88fc-5373-89f3-5cd3b5f708e3","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"{\"pages\" : \"1,2,3,4\"}","description":"JSON String containing any additional options relevant to the conversion type. In this case result will be a PDF file with 1st,2nd,3rd and 4th pages of the document.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PDF","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PDF"}]}},"response":[],"_postman_id":"b429ca7c-88fc-5373-89f3-5cd3b5f708e3"}],"id":"776dc5a8-f15b-0bbf-69dc-7fffc95c962d","event":[{"listen":"prerequest","script":{"id":"c610f80a-7ada-4497-b1e2-613881918b9e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3960390d-cd24-4dfd-88eb-bde71b166c0f","type":"text/javascript","exec":[""]}}],"_postman_id":"776dc5a8-f15b-0bbf-69dc-7fffc95c962d"},{"name":"HTML","item":[{"name":"convert HTML to PDF","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"7e738285-1a19-84b5-9627-30d4f44d62ab","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":null,"description":"This is the file to be converted to the output format.","type":"file"},{"key":"optionsJSON","value":"","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PDF","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PDF"}]}},"response":[],"_postman_id":"7e738285-1a19-84b5-9627-30d4f44d62ab"},{"name":"convert HTML to PNG","event":[{"listen":"test","script":{"id":"4a7fc0d6-65b5-4831-988c-cc21df27c842","type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"bed6d83c-dd8e-6aaf-693f-edc7047541c1","request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":"https://www.w3schools.com","description":"URL of the website to be converted.","type":"text"},{"key":"optionsJSON","value":"{\"isScreenshot\":\"true\"}","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"},{"key":"inputFileFormat","value":"html","description":"Manual format property. Should always be included in case if website URL does not contain .htm or .html extension at the end","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PNG","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PNG"}]}},"response":[],"_postman_id":"bed6d83c-dd8e-6aaf-693f-edc7047541c1"},{"name":"convert HTML to JPEG","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"02084473-234a-ee82-52de-d4bade3fd259","request":{"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":"https://www.w3schools.com","description":"URL of the website to be converted.","type":"text"},{"key":"optionsJSON","value":"{\"isScreenshot\":\"true\"}","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=JPEG","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"JPEG"}]}},"response":[],"_postman_id":"02084473-234a-ee82-52de-d4bade3fd259"},{"name":"convert HTML to TIFF","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"For Valid request, response code is 200\"] = responseCode.code === 200;"]}}],"id":"4918dc8b-869a-f8b1-17a9-6bfdc18a09d1","request":{"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","value":"https://www.w3schools.com","description":"URL of the website to be converted.","type":"text"},{"key":"optionsJSON","value":"{\"isScreenshot\":\"true\"}","description":"JSON String containing any additional options relevant to the conversion type.","type":"text"},{"key":"inputFileFormat","value":"","description":"Manual format property. Should always be included in case if website URL does not contain .htm or .html extension at the end","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=TIFF","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"TIFF"}]}},"response":[],"_postman_id":"4918dc8b-869a-f8b1-17a9-6bfdc18a09d1"}],"id":"357b0c88-42ff-18d6-66a7-2b0c19700632","_postman_id":"357b0c88-42ff-18d6-66a7-2b0c19700632"},{"name":"XML","item":[{"name":"convert XML to PDF","id":"f6d40468-1dda-4736-8253-26ba48822b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}","type":"text"},{"key":"X-SecretKey","value":"{{X-SecretKey}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"inputFile","type":"file","value":null},{"key":"optionsJSON","value":"{}","type":"text"}]},"url":{"raw":"{{serverDomain}}/convert?outputFormat=PDF","host":["{{serverDomain}}"],"path":["convert"],"query":[{"key":"outputFormat","value":"PDF"}]}},"response":[],"_postman_id":"f6d40468-1dda-4736-8253-26ba48822b10"}],"id":"db0369c4-8282-40e9-86af-f4d028166f3c","_postman_id":"db0369c4-8282-40e9-86af-f4d028166f3c"}],"id":"9a76a32c-ef1b-ccaf-bc2b-1bd26394331e","description":"Here you can see some specific examples and cases that you can face using DocBot.","_postman_id":"9a76a32c-ef1b-ccaf-bc2b-1bd26394331e"},{"name":"Code examples","item":[],"id":"392fafdf-e52f-7c66-b56d-f52aa99405d4","description":"These are conversion code examples for various programming languages.\n\nC# code example\n        \n        HttpClient client = new HttpClient();\n\n        client.Timeout = new TimeSpan(1, 10, 0);\n        client.DefaultRequestHeaders.Add(\"X-ApplicationID\", ConfigurationManager.AppSettings[\"ApplicationId\"]);\n        client.DefaultRequestHeaders.Add(\"X-SecretKey\", ConfigurationManager.AppSettings[\"SecretToken\"]);\n            \n        var inputPath = \"C:\\example.docx\";\n        var outputPath = \"C:\\example.pdf\";\n        var format = \"PDF\";\n\n        using (var fileStream = new FileStream(inputPath, FileMode.Open))\n                {\n                  var stream = new MemoryStream();\n                  fileStream.CopyTo(stream);\n                        \n                  stream.Seek(0, SeekOrigin.Begin);\n                        \n                  content.Add(new StreamContent(stream), \"inputFile\", Path.GetFileName(inputPath));\n                        \n                  content.Add(new StringContent(performAsync.ToString()), \"performAsync\");\n                  content.Add(new StringContent(new JavaScriptSerializer().Serialize(parameters)),\n                                    \"optionsJson\");\n                }\n                    \n        var url = ConfigurationManager.AppSettings.Get(\"DCAAPIUrl\");\n\n                using (var request = new HttpRequestMessage(HttpMethod.Post, $\"{url}convert?outputFormat={format}\") { Content = content })\n                {\n                    request.Headers.TryAddWithoutValidation(\"Content-Type\", \"multipart/form-data\");\n\n                    var result = await client.SendAsync(request);\n                    result.EnsureSuccessStatusCode();\n                    \n                    using (var resultStream = await result.Content.ReadAsStreamAsync())\n                            {\n                                using (var outputStream = new FileStream(outputPath, FileMode.Create))\n                                \n                                {\n                                    resultStream.CopyTo(outputStream);\n                                }\n                            }\n                }\n                \n                \nNodeJS code example\n\n\t  var request = require('request'),\n\t    fs = require('fs'),\n\t    apiKey = 'GiVUYsF4A8ssq93FR48H',\n\t    formData = {\n\t        inputFile: \"http://www.iiswc.org/iiswc2009/sample.doc\"\n\t    };\n\t\n\t    var headers = {\n\t    'X-ApplicationID': '',\n\t    'X-SecretKey' : '',\n\t    'User-Agent': 'Super Agent/0.0.1',\n\t    'Content-Type': 'application/x-www-form-urlencoded'\n\t  };\n\t\n\t  request.post({\n\t    url:'https://api.docconversionapi.com/convert?outputFormat=PDF',\n\t    formData: formData,\n\t    headers: headers,\n\t    encoding: 'binary'\n\t  }, function (err, response, body) {\n\t    fs.writeFile('output', body, 'binary', function(err) {\n\t      console.log(err);\n\t    });\n\t  });\n  \n  \nPHP code example\n\n\t  <?php\n\t  $url = 'https://api.docconversionapi.com/convert?outputFormat=PDF';\n\t  $fields = array(\n\t              'inputFile' => 'http://homepages.inf.ed.ac.uk/neilb/TestWordDoc.doc',\n           'optionsJson' => '{}'\n\t          );\n\t  \n\t  //url-ify the data for the POST\n\t  foreach($fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }\n\t  $fields_string = rtrim($fields_string,'&');\n\t  \n\t  //open connection\n\t  $ch = curl_init();\n\t  \n\t  //set the url, number of POST vars, POST data\n\t  curl_setopt($ch, CURLOPT_HTTPHEADER, array(\n\t      'X-ApplicationID: ',\n\t      'X-SecretKey: '\n\t  ));\n\t  curl_setopt($ch,CURLOPT_URL,$url);\n\t  curl_setopt($ch,CURLOPT_POST,count($fields));\n\t  curl_setopt($ch,CURLOPT_POSTFIELDS,$fields_string);\n\t  \n\t  //execute post\n\t  $result = curl_exec($ch);\n\t  print $result;\n\t  ?>\n  \n  \njQuery code example\n  \n\t  var data = {\n\t      inputFile: 'http://www.iiswc.org/iiswc2009/sample.doc'\n\t  };\n\t  \n\t  function sendPost() {\n\t      $.ajax({\n\t          type: \"POST\",\n\t          beforeSend: function(request) {\n\t              request.setRequestHeader(\"X-ApplicationID\", '');\n\t              request.setRequestHeader(\"X-SecretKey\", '');\n\t          },\n\t          url: 'https://api.docconversionapi.com/convert?outputFormat=PDF',\n\t          data: data,\n\t          success: function(response){\n\t              console.log(response);\n\t          }\n\t      });\n\t  }\n\t  \n\t  sendPost();\n  \nPlain JavaScript code example\n\n\t  const url = \"https://api.docconversionapi.com/convert?outputFormat=PDF\";\n\t  fetch(url, {\n\t      method : \"POST\",\n\t      body: new FormData({\n\t          inputFile: 'http://www.iiswc.org/iiswc2009/sample.doc'\n\t      }),\n\t      headers: new Headers({\n\t          'X-ApplicationID': '3859f0cc-fe6a-4a99-99a2-dffd5ea42046',\n\t          'X-SecretKey' : '76b3f2d5-6559-4895-a64d-bcbc86d4e827',\n\t          'Content-Type': 'multipart/form-data'\n\t      })\n\t  }).then(\n\t      response => response.text() // .json(), etc.\n\t      // same as function(response) {return response.text();}\n\t  ).then(\n\t      html => console.log(html)\n\t  );\n  \nJava code example\n\n  \n\t  package com.journaldev.utils;\n\t  \n\t  import java.io.BufferedReader;\n\t  import java.io.IOException;\n\t  import java.io.InputStreamReader;\n\t  import java.io.OutputStream;\n\t  import java.net.HttpURLConnection;\n\t  import java.net.URL;\n\t  \n\t  public class HelloWorld {\n\t  \n\t    private static final String USER_AGENT = \"Mozilla/5.0\";\n\t  \n\t    private static final String GET_URL = \"https://api.docconversionapi.com/status\";\n\t  \n\t    public static void main(String[] args) throws IOException {\n\t  \n\t      sendGET();\n\t      System.out.println(\"GET DONE\");\n\t    }\n\t  \n\t    private static void sendGET() throws IOException {\n\t      URL obj = new URL(GET_URL);\n\t      HttpURLConnection con = (HttpURLConnection) obj.openConnection();\n\t      con.setRequestMethod(\"GET\");\n\t      con.setRequestProperty(\"User-Agent\", USER_AGENT);\n\t      con.setRequestProperty(\"X-ApplicationID\", \"\");\n\t      con.setRequestProperty(\"X-SecretKey\", \"\");\n\t      int responseCode = con.getResponseCode();\n\t      System.out.println(\"GET Response Code :: \" + responseCode);\n\t      if (responseCode == HttpURLConnection.HTTP_OK) { // success\n\t        BufferedReader in = new BufferedReader(new InputStreamReader(\n\t            con.getInputStream()));\n\t        String inputLine;\n\t        StringBuffer response = new StringBuffer();\n\t  \n\t        while ((inputLine = in.readLine()) != null) {\n\t          response.append(inputLine);\n\t        }\n\t        in.close();\n\t  \n\t        // print result\n\t        System.out.println(response.toString());\n\t      } else {\n\t        System.out.println(\"GET request not worked\");\n\t      }\n\t  \n\t    }\n\t  }\n\nSwift code example\n\n\t  override func viewDidLoad() {\n\t        super.viewDidLoad()\n\t        \n\t        var url = URL(string: \"https://api.docconversionapi.com/status\")\n\t        var request = URLRequest(url: url!)\n\t        request.setValue(\"\", forHTTPHeaderField: \"X-ApplicationID\")\n\t        request.setValue(\"\", forHTTPHeaderField: \"X-SecretKey\")\n\t        \n\t        let task = URLSession.shared.dataTask(with: url!) { (data, response, error) in\n\t                if error != nil {\n\t                    print(error)\n\t                } else {\n\t                    do {\n\t                        let json = try JSONSerialization.jsonObject(with: data!, options: .allowFragments) as! [String:Any]\n\t                    }\n\t                    catch let parser as NSError {\n\t                        \n\t                    }\n\t                }\n\t            }\n\t            task.resume()\n\t    }\n    \n    \nReact Native code example\n\n\n\t\timport React from 'react';\n\t\timport { FlatList, ActivityIndicator, Text, View  } from 'react-native';\n\t\t\n\t\texport default class FetchExample extends React.Component {\n\t\t\n\t\t  constructor(props){\n\t\t    super(props);\n\t\t    this.state ={ isLoading: true}\n\t\t  }\n\t\t\n\t\t  render(){\n\t\t\n\t\t    if(this.state.isLoading){\n\t\t      return(\n\t\t        <View style={{flex: 1, padding: 20}}>\n\t\t          <ActivityIndicator/>\n\t\t        </View>\n\t\t      )\n\t\t    }\n\t\t\n\t\t    return(\n\t\t      <View style={{flex: 1, paddingTop:20}}>\n\t\t        <FlatList\n\t\t          data={this.state.dataSource}\n\t\t          renderItem={({item}) => <Text>{item.title}, {item.releaseYear}</Text>}\n\t\t          keyExtractor={(item, index) => index}\n\t\t        />\n\t\t      </View>\n\t\t    );\n\t\t  }\n\t\t}\n","_postman_id":"392fafdf-e52f-7c66-b56d-f52aa99405d4"}],"id":"141ecd7c-8b2c-4d8a-ab34-f63842c41ed4","description":"DocBot is our API which allows you to manipulate document files by converting documents to different formats, editing their metadata, applying encryption or protection features and much more.","event":[{"listen":"prerequest","script":{"id":"caab9ad0-dd9d-40fd-96c0-edc33677ff6e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"879dea9d-ed0e-42a5-b6b3-6c6c986fa3e3","type":"text/javascript","exec":[""]}}],"_postman_id":"141ecd7c-8b2c-4d8a-ab34-f63842c41ed4"},{"name":"VirusBot","item":[{"name":"API Reference","item":[{"name":"Scan Files","event":[{"listen":"test","script":{"id":"b4e6ec00-8faf-4839-ae5e-7e75520a7475","type":"text/javascript","exec":[""]}}],"id":"89e28e30-8b82-4632-8054-60400f517124","request":{"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}","description":"This should be a unique Application ID associated with your account."},{"key":"X-SecretKey","value":"{{X-SecretKey}}","description":"This should be the Secret API Key which corresponds to the Application ID provided."}],"body":{"mode":"formdata","formdata":[{"key":"file","value":null,"type":"file","description":"This should be a File upload.  You may includes as many files in the upload as you like."},{"key":"file1","value":null,"type":"file","description":"A second file (if applicable)."},{"key":"inputFile","value":"https://cdn.shopify.com/s/files/1/0663/1049/products/Sunflowers_1024x1024.jpg","description":"Option for URL scanning. Contains URL of the file that should be scanned.","type":"text"}]},"url":"{{serverDomain}}/scan","description":"Stateless request to scan files. Sends them over sync HTTP communication between services."},"response":[],"_postman_id":"89e28e30-8b82-4632-8054-60400f517124"}],"id":"6157b2cb-eccf-4f0a-ade8-739534dc8efc","_postman_id":"6157b2cb-eccf-4f0a-ade8-739534dc8efc"}],"id":"90130a15-ed19-4b20-a26b-55a4e5484afa","description":"VirusBot is out API which allows you to scan your files for viruses.\n\nC# code example\n\t\t\t\t\n\t\t\tusing (var content = new MultipartFormDataContent())\n            {\n                int index = 0;\n\n                foreach (var path in inputPaths)\n                {\n                    using (var fileStream = new FileStream(path, FileMode.Open))\n                    {\n                        var stream = new MemoryStream();\n                        fileStream.CopyTo(stream);\n                        stream.Seek(0, SeekOrigin.Begin);\n                        content.Add(new StreamContent(stream), \"inputFile\" + index, Path.GetFileName(path));\n                        content.Add(new StringContent(\"true\"), \"async\");\n                    }\n\n                    index++;\n                }\n                content.Add(new StringContent(new JavaScriptSerializer().Serialize(parameters)),\n                                    \"optionsJson\");\n                                    \n                var inputPath = \"C:\\example.docx\";\n                var url = ConfigurationManager.AppSettings.Get(\"DCAAPIUrl\");\n                using (var request = new HttpRequestMessage(HttpMethod.Post, $\"{url}scan\") { Content = content })\n                {\n                    request.Headers.TryAddWithoutValidation(\"Content-Type\", \"application/x-www-form-urlencoded\");\n\n                    var result = await client.SendAsync(request);\n                \tresult.EnsureSuccessStatusCode();\n                \t\n                \tusing (var resultStream = await result.Content.ReadAsStreamAsync())\n                    {\n                        using (var outputStream = new FileStream(outputPath, FileMode.Create))\n                        {\n                            resultStream.CopyTo(outputStream);\n                        }\n                    }\n                }","event":[{"listen":"prerequest","script":{"id":"478a120d-9c67-499e-8a8e-82a6485d7bc7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"050ff969-87a0-495d-b1ff-f5e64fac9067","type":"text/javascript","exec":[""]}}],"_postman_id":"90130a15-ed19-4b20-a26b-55a4e5484afa"},{"name":"MergeBot","item":[{"name":"merge","id":"9a2b77c4-e745-4f26-91bb-70c2e0ffa4e2","request":{"method":"POST","header":[{"key":"X-ApplicationID","value":"{{X-ApplicationID}}"},{"key":"X-SecretKey","value":"{{X-SecretKey}}"}],"body":{"mode":"formdata","formdata":[{"key":"optionsJSON","value":"{\n\"documentName\":\"Example Merge Document\", \"isPortfolio\":\"false\", \n\"createTitlePage\":\"true\",\n\"filePassword\": \"123456\",\n\"footerOptions\":{\"left\":\"0\", \"bottom\":\"20\", \"right\":\"20\", \"top\":\"0\", \"leftFooterText\":\"Example left footer text\"}\n}","type":"text"},{"key":"file1","value":null,"type":"file"},{"key":"file2","value":null,"type":"file"}]},"url":"{{serverDomain}}/merge","description":"Merges N files into one. Options are available. Configured footer."},"response":[],"_postman_id":"9a2b77c4-e745-4f26-91bb-70c2e0ffa4e2"}],"id":"3ecf0216-425a-4e5f-b7b6-0821827e76ce","description":"MergeBot is our API which allows you to merge your app data into Microsoft Word or other richly formatted templates.  \n\nC# code example\n\t\t\t\t\n\t\t\t\tHttpClient client = new HttpClient();\n\n\t\t\t\tclient.Timeout = new TimeSpan(1, 10, 0);\n\t\t\t\tclient.DefaultRequestHeaders.Add(\"X-ApplicationID\", ConfigurationManager.AppSettings[\"ApplicationId\"]);\n\t\t\t\tclient.DefaultRequestHeaders.Add(\"X-SecretKey\", ConfigurationManager.AppSettings[\"SecretToken\"]);\n            \n\t\t\t\tvar inputPaths = new string[2] { \"C:\\example.pdf\", \"C:\\example2.pdf\" };\n\t\t\t\tvar outputPath = \"C:\\result.pdf\";\n\t\t\t\t\n\t\t\t\tusing (var content = new MultipartFormDataContent())\n            \t{\n\t                int index = 0;\n\t\n\t                foreach (var path in inputPaths)\n\t                {\n\t                    using (var fileStream = new FileStream(path, FileMode.Open))\n\t                    {\n\t                        var stream = new MemoryStream();\n\t                        fileStream.CopyTo(stream);\n\t                        stream.Seek(0, SeekOrigin.Begin);\n\t                        content.Add(new StreamContent(stream), \"inputFile\" + index, Path.GetFileName(path));\n\t                    }\n\t\n\t                    index++;\n\t                }\n\t                \n\t                content.Add(new StringContent(new JavaScriptSerializer().Serialize(parameters)),\n\t                                    \"optionsJson\");\n\t                content.Add(new StringContent(performAsync.ToString()), \"performAsync\");\n\t\n\t                var url = ConfigurationManager.AppSettings.Get(\"DCAAPIUrl\");\n\t                using (var request = new HttpRequestMessage(HttpMethod.Post, $\"{url}merge\") { Content = content })\n\t                {\n\t                    request.Headers.TryAddWithoutValidation(\"Content-Type\", \"application/x-www-form-urlencoded\");\n\t\n\t                    var result = await client.SendAsync(request);\n\t\t                result.EnsureSuccessStatusCode();\n\t\t                \n\t\t                using (var resultStream = await result.Content.ReadAsStreamAsync())\n\t\t                {\n\t\t                    using (var outputStream = new FileStream(outputPath, FileMode.Create))\n\t\t                    {\n\t\t                        resultStream.CopyTo(outputStream);\n\t\t                    }\n\t\t                }\n\t                }\n            \t}","event":[{"listen":"prerequest","script":{"id":"0c010c96-991d-4ac7-968f-59882f633675","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3e238411-b86f-4d9e-a106-4f573caec75b","type":"text/javascript","exec":[""]}}],"_postman_id":"3ecf0216-425a-4e5f-b7b6-0821827e76ce"}],"event":[{"listen":"prerequest","script":{"id":"29645d6d-cef8-467c-b961-7452569d752a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"815f8ffd-b65a-4d70-bdf6-4949dfb4742d","type":"text/javascript","exec":[""]}}]}