Comparison API
Zoho Writer comparison API provides a user-friendly viewer for comparing documents.
The API accepts a pair of documents as input and returns a comparison viewer URL as a response. When a user accesses the said URL in a browser, the documents are displayed in Writer with changes highlighted.
Purpose
To compare two versions of a document and highlight the difference in text.
HTTP Request URL
https://{api.office-integrator_domain}/writer/officeapi/v1/document/compare
Request Parameters
Parameter | Data Type | Description |
Mandatory Parameters | ||
apikey | 423s***** | Uniquely identifies the web application, which initiates the document comparison request. |
document1 or url1 | File or String | Method of providing the input file depending on its location. document1 - If the old version of the input file is from your local drive or desktop. url1 - If the old version of the input file is from a publicly accessible Web URL. |
document2 or url2 | File or String | Method of providing the input file depending on its location. document2 - If the updated version of the input file is from your local drive or desktop. url2 - If the updated version of the input file is from a publicly accessible Web URL. |
Optional Parameters | ||
title | String | Defines document title of the 2 versions of comparison files. Note: If the user fails to provide a value for 'title' parameter, Zoho Writer will combine the names from 'document1' & 'document2' parameters, and replace it as the title |
lang | String | Enables the editor interface to open in Writer supported languages. Default value: en (English) |
Comparison API - Error Codes
Code | Description |
1831 | Error occurred. Parameter value is either incorrect or invalid. |
1852 | File format you're trying to import is not supported. |
1868 | Invalid parameter name for uploaded content. |
For a full list of error handling cases in Comparison API, refer here.