Document Merger Cloud API

Browse our Products

Are you looking for an evaluation version of a product?

If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.

Are you having troubles in downloading?

If you experience errors, when you try to download a file, make sure your network policies (enforced by your company or ISP) allow downloading ZIP and/or MSI files.

Installation
The package is available at PyPI and it can be installed via pip by executing following command:
pip install groupdocs-merger-cloud

Requirements

Python 2.7 or 3.4+
pip package manager
GroupDocs Cloud credentials — Client ID and Client Secret from the Dashboard

Dependencies

The SDK automatically installs the following packages:

Package	Constraint
urllib3	>= 1.15
six	>= 1.10
certifi	—
python-dateutil	—

Quick Start

Get your API credentials

To use GroupDocs.Merger Cloud, sign up at GroupDocs.Cloud Dashboard and get your Client ID and Client Secret.

Initialize the API

Use the following code to start using the GroupDocs.Merger Cloud SDK for Python:

import groupdocs_merger_cloud

# Get your ClientId and ClientSecret at https://dashboard.groupdocs.cloud
client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create API configuration
configuration = groupdocs_merger_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"

# Create instance of the Document API
document_api = groupdocs_merger_cloud.DocumentApi.from_config(configuration)

Merge multiple documents

Once initialized, use this basic example to merge Word documents into one file:

import groupdocs_merger_cloud

client_id = "YourClientId"
client_secret = "YourClientSecret"

document_api = groupdocs_merger_cloud.DocumentApi.from_keys(client_id, client_secret)

item1 = groupdocs_merger_cloud.JoinItem()
item1.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/four-pages.docx")

item2 = groupdocs_merger_cloud.JoinItem()
item2.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/one-page.docx")

options = groupdocs_merger_cloud.JoinOptions()
options.join_items = [item1, item2]
options.output_path = "Output/joined.docx"

result = document_api.join(groupdocs_merger_cloud.JoinRequest(options))

print("Output file path = " + result.path)

With this quick start guide, you’re all set to begin merging documents using GroupDocs.Merger Cloud in your Python applications. For more details, visit the documentation.

Get Supported File Formats

Retrieve the full list of supported file formats available through the Merger API.

import groupdocs_merger_cloud

info_api = groupdocs_merger_cloud.InfoApi.from_keys("YourClientId", "YourClientSecret")

result = info_api.get_supported_file_formats()

for fmt in result.formats:
    print(fmt.file_format)

Join Pages from Various Documents

Merge specific pages from multiple source documents into a single output file, with support for page ranges and filters.

import groupdocs_merger_cloud

document_api = groupdocs_merger_cloud.DocumentApi.from_keys("YourClientId", "YourClientSecret")

item1 = groupdocs_merger_cloud.JoinItem()
item1.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/sample-10-pages.docx")
item1.pages = [3, 6, 8]

item2 = groupdocs_merger_cloud.JoinItem()
item2.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/four-pages.docx")
item2.start_page_number = 1
item2.end_page_number = 4
item2.range_mode = "OddPages"

options = groupdocs_merger_cloud.JoinOptions()
options.join_items = [item1, item2]
options.output_path = "Output/joined-pages.docx"

result = document_api.join(groupdocs_merger_cloud.JoinRequest(options))

print("Output file path = " + result.path)

Merge Documents Across Formats into PDF

Merge documents of different formats (e.g., password-protected PDF and DOCX) into a single PDF file.

import groupdocs_merger_cloud

document_api = groupdocs_merger_cloud.DocumentApi.from_keys("YourClientId", "YourClientSecret")

item1 = groupdocs_merger_cloud.JoinItem()
item1.file_info = groupdocs_merger_cloud.FileInfo(
    "Pdf/one-page-password.pdf", None, None, "password"
)

item2 = groupdocs_merger_cloud.JoinItem()
item2.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/one-page.docx")

options = groupdocs_merger_cloud.JoinOptions()
options.join_items = [item1, item2]
options.output_path = "Output/joined.pdf"

result = document_api.join(groupdocs_merger_cloud.JoinRequest(options))

print("Output file path = " + result.path)

Split Document into Single Pages

Split a document into separate files by specifying exact page numbers.

import groupdocs_merger_cloud

document_api = groupdocs_merger_cloud.DocumentApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_merger_cloud.SplitOptions()
options.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/sample-10-pages.docx")
options.output_path = "Output/split-document"
options.pages = [1, 3]
options.mode = "Pages"

result = document_api.split(groupdocs_merger_cloud.SplitRequest(options))

print("Documents count = " + str(len(result.documents)))

Extract Pages by Numbers

Extract specific pages from a document into a new file.

import groupdocs_merger_cloud

pages_api = groupdocs_merger_cloud.PagesApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_merger_cloud.ExtractOptions()
options.file_info = groupdocs_merger_cloud.FileInfo("WordProcessing/sample-10-pages.docx")
options.output_path = "Output/extract-pages-by-numbers.docx"
options.pages = [2, 4, 7]

result = pages_api.extract(groupdocs_merger_cloud.ExtractRequest(options))

print("Output file path = " + result.path)

Rotate Document Pages

Rotate selected pages in a PDF document to adjust their orientation.

import groupdocs_merger_cloud

pages_api = groupdocs_merger_cloud.PagesApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_merger_cloud.RotateOptions()
options.file_info = groupdocs_merger_cloud.FileInfo("Pdf/ten-pages.pdf")
options.output_path = "Output/rotate-pages.pdf"
options.pages = [2, 4]
options.mode = "Rotate90"

result = pages_api.rotate(groupdocs_merger_cloud.RotateRequest(options))

print("Output file path = " + result.path)

Add Password to Document

Secure a document by adding password protection.

import groupdocs_merger_cloud

security_api = groupdocs_merger_cloud.SecurityApi.from_keys("YourClientId", "YourClientSecret")

options = groupdocs_merger_cloud.Options()
options.file_info = groupdocs_merger_cloud.FileInfo(
    "WordProcessing/one-page.docx", None, None, "password"
)
options.output_path = "Output/add-password.docx"

result = security_api.add_password(groupdocs_merger_cloud.AddPasswordRequest(options))

print("Output file path = " + result.path)

Sample Projects on GitHub

The GroupDocs.Merger Cloud Python Samples repository includes ready-to-run examples covering:

Category	Examples
Info	Supported file types, document information
Document Operations	Join multiple documents, cross-format join, join pages, join images, split documents, preview, import attachment
Pages Operations	Extract pages, move pages, remove pages, rotate pages, swap pages, change orientation
Security Operations	Add, remove, update password; check password protection

How to run the examples

Clone or download the samples repository
Edit Examples/Common.py and set your client_id and client_secret
Go to the Examples directory
Run pip install groupdocs-merger-cloud -U
Execute python RunExamples.py

For more details, visit Getting Started.