SDKs overview

Cloudmersive Document and Data Conversion offers a suite of Software Development Kits (SDKs) to simplify integration with its API services. These SDKs abstract the underlying RESTful API endpoints, allowing developers to interact with services like document conversion, virus scanning, and data validation using native language constructs rather than direct HTTP requests. The official SDKs are generated to provide consistent access to the Cloudmersive API's functionality across various programming environments.

The availability of SDKs for multiple languages aims to reduce the boilerplate code required for API interactions, including request construction, response parsing, and error handling. This approach aligns with common practices in API design, where SDKs are provided to enhance developer experience and reduce integration time. For instance, many API providers, such as Stripe's API documentation, offer similar language-specific libraries to streamline development.

Cloudmersive maintains official SDKs for popular programming languages. These libraries are generally kept up-to-date with the latest API versions and features, ensuring that developers can access new capabilities as they are released. The Cloudmersive API documentation provides detailed guides and code examples for each SDK, covering typical use cases and configuration steps.

Official SDKs by language

Cloudmersive Document and Data Conversion provides official SDKs for several programming languages, designed to facilitate integration with its various API services. These SDKs are maintained by Cloudmersive and are available through standard package managers for each respective language.

Language Package Name Installation Command Maturity
C# Cloudmersive.APIClient.NET.DocumentAndDataConversion dotnet add package Cloudmersive.APIClient.NET.DocumentAndDataConversion Stable
Java com.cloudmersive.client.rt (Maven/Gradle artifact) Add to pom.xml or build.gradle Stable
Node.js cloudmersive-convert-api-client npm install cloudmersive-convert-api-client Stable
PHP cloudmersive/cloudmersive-convert-api-client composer require cloudmersive/cloudmersive-convert-api-client Stable
Python cloudmersive-convert-api-client pip install cloudmersive-convert-api-client Stable
Ruby cloudmersive-convert-api-client gem install cloudmersive-convert-api-client Stable
Go github.com/cloudmersive/cloudmersive-convert-api-client-go go get github.com/cloudmersive/cloudmersive-convert-api-client-go Stable

Each SDK provides client classes and methods corresponding to the various API controllers and endpoints offered by Cloudmersive. This includes functions for document format conversion (e.g., PDF to DOCX), image processing, data validation (e.g., email validation), and security services like virus scanning.

Installation

Installing the Cloudmersive Document and Data Conversion SDKs typically involves using the standard package manager for the target programming language. The specific steps vary by language, but the general process is to add the SDK as a dependency to your project.

C#

For C# projects, the SDK is available as a NuGet package:

dotnet add package Cloudmersive.APIClient.NET.DocumentAndDataConversion

Alternatively, you can install it via the NuGet Package Manager in Visual Studio.

Java

For Java projects using Maven, add the following dependency to your pom.xml:

<dependency>
    <groupId>com.cloudmersive.client.rt</groupId>
    <artifactId>cloudmersive-convert-api-client</artifactId>
    <version>2.1.6</version> <!-- Check Cloudmersive API client Java documentation for the latest version -->
</dependency>

For Gradle, add to your build.gradle:

implementation 'com.cloudmersive.client.rt:cloudmersive-convert-api-client:2.1.6' <!-- Check Cloudmersive API client Java documentation for the latest version -->

Node.js

For Node.js applications, install the SDK via npm:

npm install cloudmersive-convert-api-client

PHP

For PHP projects using Composer, add the SDK as a dependency:

composer require cloudmersive/cloudmersive-convert-api-client

Python

For Python environments, install the SDK using pip:

pip install cloudmersive-convert-api-client

Ruby

For Ruby applications, install the gem:

gem install cloudmersive-convert-api-client

Go

For Go projects, retrieve the module:

go get github.com/cloudmersive/cloudmersive-convert-api-client-go

After installation, the SDK can be imported into your project and configured with your Cloudmersive API Key, which can be obtained from the Cloudmersive developer documentation.

Quickstart example

The following quickstart example demonstrates how to convert a DOCX file to PDF using the Cloudmersive Document and Data Conversion API via the Python SDK. This example assumes you have installed the Python SDK and have a valid Cloudmersive API key.

Python: DOCX to PDF Conversion

First, ensure the Python SDK is installed:

pip install cloudmersive-convert-api-client

Then, use the following Python code:

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY' # Replace with your actual API Key

# create an instance of the API class
api_client = cloudmersive_convert_api_client.ApiClient(configuration)
convert_api = cloudmersive_convert_api_client.ConvertDocumentApi(api_client)

try:
    # Convert Word DOCX to PDF
    # Input file to perform the operation on. A file in DOCX format.
    input_file = '/path/to/your/document.docx' # Replace with your DOCX file path
    
    # Get the file and convert it
    api_response = convert_api.convert_document_docx_to_pdf(input_file)
    pprint(api_response)
    
    # Save the converted PDF to a file
    with open('output.pdf', 'wb') as f:
        f.write(api_response.read())
    print("DOCX successfully converted to PDF and saved as output.pdf")

except ApiException as e:
    print("Exception when calling ConvertDocumentApi->convert_document_docx_to_pdf: %s\n" % e)

This snippet initializes the API client with your API key, specifies the input file, calls the convert_document_docx_to_pdf method, and saves the resulting PDF to a local file. Similar patterns apply to other conversion and data processing operations available through the Cloudmersive API, as detailed in the Cloudmersive API reference.

For more detailed examples across different languages and various API functions, developers should consult the official Cloudmersive developer documentation, which includes code samples for all supported SDKs.

Community libraries

As of 2026-05-29, Cloudmersive Document and Data Conversion primarily focuses on providing and maintaining official SDKs for a range of popular programming languages. These official SDKs are designed to cover the full spectrum of API functionality and are regularly updated to reflect new features and improvements.

While official SDKs are the recommended method for integrating with the Cloudmersive API, the nature of public APIs means that community-contributed libraries can emerge. These might include wrappers for unsupported languages, specialized tools, or integrations with specific frameworks. However, such community projects are not officially endorsed or maintained by Cloudmersive.

Developers who require an SDK for a language not officially supported or have specific integration needs might consider developing a custom client library. The Cloudmersive API is a standard RESTful web service, meaning it can be accessed using any HTTP client library available in virtually any programming language. This flexibility allows for custom implementations where official SDKs may not perfectly fit a project's requirements or where a niche language is in use.

When evaluating community-contributed libraries, it is advisable to consider factors such as maintenance status, community support, security practices, and adherence to the latest Cloudmersive API specifications. For most use cases, the official SDKs provide the most reliable and up-to-date integration path, supported directly by Cloudmersive.