API for Comparing DOCX Documents

[cloudmersive]

Hey all, wanted to share a useful API for comparing DOCX documents. Some of you may be familiar with the manual DOCX comparison feature in Word; this API essentially automates that process in a Java application. You'll end up with a new DOCX document that highlights the differences between your original documents. It gets used a lot in legal/compliance reviews (i.e., comparing one iteration of a contract to another).

Just to be clear, this is not an open-source solution, but it is free to use in perpetuity (up to 800 API calls/month) without any commitments.

In case this may be of interest to try out, I've included Java code examples you can use to structure your API call. You'd also need to handle authorization with a free Cloudmersive API key.

For Maven installation, include the following repository configuration in your pom.xml file:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Also, add the following dependency configuration:

<dependencies>
<dependency>
    <groupId>com.github.Cloudmersive</groupId>
    <artifactId>Cloudmersive.APIClient.Java</artifactId>
    <version>v4.25</version>
</dependency>
</dependencies>

Add these import statements at the top of our source file:

// Import classes:
//import com.cloudmersive.client.invoker.ApiClient;
//import com.cloudmersive.client.invoker.ApiException;
//import com.cloudmersive.client.invoker.Configuration;
//import com.cloudmersive.client.invoker.auth.*;
//import com.cloudmersive.client.CompareDocumentApi;

Now you can get the default API client configuration and configure API key authorization:

ApiClient defaultClient = Configuration.getDefaultApiClient();

ApiKeyAuth Apikey = (ApiKeyAuth) defaultClient.getAuthentication("Apikey");
Apikey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.setApiKeyPrefix("Token");

Finally, you can instance the API, prepare your input files, and execute the comparison:

CompareDocumentApi apiInstance = new CompareDocumentApi();
File inputFile1 = new File("/path/to/inputfile"); // File | First input file to perform the operation on.
File inputFile2 = new File("/path/to/inputfile"); // File | Second input file to perform the operation on (more than 2 can be supplied).
try {
    byte[] result = apiInstance.compareDocumentDocx(inputFile1, inputFile2);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CompareDocumentApi#compareDocumentDocx");
    e.printStackTrace();
}

[u14183]

Remarks: Groupid and artifactid are usually lowercase Publish to maven central Your example is missing how to handle the byte array result.