Doc Converter Pro Web Rest API

How to call our API to convert documents from within your own application

Before you begin you need to have an account with our Doc Converter Pro Online Web App. If you not, please register for an account now. You can test the service for free but for production you will need to sign up for one of our paid plans.

Currently the Doc Converter Pro Web Rest API exposes the following API calls:

1 - API Authorization Call

https://api.docconverter.pro/token - this API call will return access token valid for 14 days, method requires 3 parameters:

username - set your DocConverterPro email
password - set your DocConverterPro password
grant_type - set to 'password' value

We strongly recommmend storing token in some cache or database and reuse it for each conversion call. Please check sample apps code how to get and use token.

2 - Convert Document API Call

https://api.docconverter.pro/api/converter/convertdoc - this API call will convert files sent via POST and will return URL/JSON/RawData or post back to a given URL the converted zip or output file.

The input parameters are:

send a file in a FormData (JavaScript) or as MultipartFormDataContent, please see the sample page or other samples for implementation details
template - optionally specify a template name parameter, for instance: 'Convert to HTML5' . This template is used by default if a parameter is not specified. The template name has to be exactly as on your Doc Converter Pro Online templates list. You can create your own custom templates and use it.
returnJson - option to return json with a list of converted output file URLs (attention: do not set returnHtml or returnData options if you want to use returnJson)
returnHtml - option to return either a zip file (set it to false) with all the conversion files in it or a single output file (set it to true). By default it's set to 'false' - return a zip file. To return only a HTML file set this option to 'true'.
Note 1: that if you set it to true then only the html file is returned, other files like images or CSS files are not sent. Only the zip file contains all the converted files.
Note 2: if you split document to pages or use split by tag feature in conversion template then API will return zip file anyway.
returnData - option to return raw octet-stream data, default is 'false' and it returns url to converted file on the Doc Converter Pro Web API server
backUrl - if specified, API method will convert input file and will POST it back to that specified URL. Please note that you need a web server to process POST request, please check out ASP.NET C# sample app that receives file sent via POST from that API method or this PHP sample code.

3 - Merge Documents API Call

https://api.docconverter.pro/api/merge/mergedocuments - this API call will merge input files and it will return URL/Raw file data or post will it back to a given URL the merged file.

The input parameters are:

send at least two files in a FormData (JavaScript) or as MultipartFormDataContent, please see the sample page or other samples for implementation details
outputformat - optional merged output format type: DOCX (default), PDF, RTF, TXT
outputfilename - optional output file name without extension
pdfcompliance - optional PDF compliance (only if PDF output format is set): PDF17 (default), PDFA1A, PDFA1B
pdfimagestype - optional PDF images type (only if PDF output format is set): AUTO (default), JPEG
pdfjpgquality - optional PDF JPEG image quality (only if PDF output format and JPEG image type is set): 10~100 values, default is 90.
returnData - option to return raw octet-stream data, default is 'false' and it returns url to merged file on the Doc Converter Pro Web API server
backUrl - if specified, API method will merge input files and will POST merged output file to that specified url. Please note that you need a web server to process POST request, please check out ASP.NET C# sample app that receives file sent via POST from that API method or this PHP sample code.

4 - Get currently used conversions and max conversions API Call

https://api.docconverter.pro/api/convert/conversionsinfo - this API call return json data with two values Conversions (currently used conversion count) and MaxConversions (maximum conversions count). MaxConversions minus Converisions will give a number of conversions left.

API Throttling

DCP Web API throttles requests per IP. You can convert maximum 2 documents per second, 40 documents per minute, 1000 per hour and 20000 per day. The best is to wait until conversion of given document is done then send another API conversion request. When converting lots of small documents we recommend to measure how many documents you convert per second/minute etc, otherwise you will get API quota exceeded error.

Check out API test web page (Javascript/jQuery sample)...

We have created a sample page that demonstrates how the API conversion works: Doc Converter Pro Web API Test Page

How to use the sample page:

enter your login credentials, the same login as your Doc Converter Pro Online account and click the Log In button. If you don't have a Doc Converter Pro Online account yet please Register for free.
select the input document file that you want to convert
optionally enter a template name
optionally choose if you want to return a zip file with all output conversion files or just get the output file back
optionally choose if you want to return json list of output file URLs, raw data or URL string to that data file located on our server, using raw data option with return html option is useful if you want to use only converted html right away
also you can enable sending file back to a given URL via POST, please specify a URL that will process a POST request

Example JavaScript code ...

Please check out Javascript sample code or view the HTML and PostJsCode.js file source code of Web API Test Page to see how you can use this API method in Javascript.

Example PHP code ...

Please check out WebAPIPhpSample.zip sample PHP/HTML code that demos how to get API token and convert uploaded file. Extract zip to a php web server. Edit convert.php file and enter your Doc Converter Pro Online email and password on line 28. Set write permissions on upload/ folder if needed. Go to index.php in a browser, then select document to convert and click Start Converting button.

Example .NET Winforms C# app...

Please check out WebAPITestApp.zip sample .NET Winforms C# app that does the same as PostConvertReturn.html sample page. Based on that sample app C# code you can write code for ASP .NET MVC web applications as well.

Example Java code ...

Please check out WebAPIJavaSample.zip sample Java code that demos how to get API token and convert uploaded file. Extract zip and edit WordCleanerWebApi.java file and enter your Doc Converter Pro Online email and password in GetAccessToken() method. Enter your doc file name and path and run.

Example Ruby code ...

Please check out WebAPIRubySample.zip sample Ruby code that demos how to get API token and convert sample doc file. Extract zip and edit dcp_web_api_sample.rb file and enter your Doc Converter Pro Online email and password on line 6 that gets api token. Make sure to install multipart-post gem: gem install multipart-post and then run this sample with: ruby dcp_web_api_sample.rb

Example Python code ...

Please check out WebAPIPythonSample.zip sample Pyton code that demos how to get API token and convert uploaded file to HTML5. Extract zip and edit docconverter_pro_api_sample.py file and enter your Doc Converter Pro Online email and password at 223 and 224 lines.

The Web API uses the same template files that you got on your Doc Converter Pro Online account; therefore, you can use the Doc Converter Pro Online version to prepare your template and preform any testing.