Merge several documents into one

Merges several Word, PDF documents to a single document.

Merge several Word, PDF documents to a single document REST API

Server	Method	Endpoint
`https://api.aspose.cloud/v4.0`	PUT	`/words/online/put/appendDocument`

You can use the following parameters in a REST request:

Parameter Name	Data Type	Required/Optional	Description
`loadEncoding`	string	Optional	Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
`password`	string	Optional	Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
`encryptedPassword`	string	Optional	Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
`destFileName`	string	Optional	Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
`revisionAuthor`	string	Optional	Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
`revisionDateTime`	string	Optional	The date and time to use for revisions.

Use $multipart/form-data request to combine one or more properties into a single body:

Property Name	Data Type	Required/Optional	Description
`document`	string(binary)	Required	Original document.
`documentList`	BaseEntryList	Required	with a list of entries to append

Note: to access this REST API, you need to register and get personal credentials. Use the ‘Quick Start’ guide to go through the procedure in a couple of minutes.

Merge several Word, PDF documents to a single document usage examples

Let’s look at practical examples of using the web service. You can do this both with cURL and Postman utilities, and from your code in various programming languages: Python, Java, JavaScript, C#, PHP, C++, Go, Ruby, Swift, Dart.

How to merge several Word, PDF documents to a single document with cURL or Postman

One of the easiest and fastest ways to call a REST API is to use cURL or Postman:

cURL Request

	curl -v "https://api.aspose.cloud/v4.0/words/online/put/appendDocument" \
	-X PUT \
	-H "Content-Type: multipart/form-data" \
	-H "Authorization: Bearer ####################" \
	-F Document="@Sample.docx" \
	-F DocumentList="{\"DocumentEntries\":[{\"FileReference\":{\"Reference\":\"Sample.docx\",\"Source\":\"Request\"},\"ImportFormatMode\":\"KeepSourceFormatting\"}]}"

view raw AppendDocumentOnline.curl hosted with ❤ by GitHub

To get a JWT token use these instructions

Postman Request

	{
	"info": {
	"name": "AppendDocumentOnline",
	"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"auth": {
	"type": "oauth2",
	"oauth2": [
	{
	"key": "clientSecret",
	"value": "{{CLIENT_SECRET}}",
	"type": "string"
	},
	{
	"key": "clientId",
	"value": "{{CLIENT_ID}}",
	"type": "string"
	},
	{
	"key": "addTokenTo",
	"value": "header",
	"type": "string"
	},
	{
	"key": "client_authentication",
	"value": "body",
	"type": "string"
	},
	{
	"key": "accessTokenUrl",
	"value": "https://api.aspose.cloud/connect/token",
	"type": "string"
	},
	{
	"key": "grant_type",
	"value": "client_credentials",
	"type": "string"
	},
	{
	"key": "tokenName",
	"value": "Access Token",
	"type": "string"
	}
	]
	},
	"item": [
	{
	"name": "appendRequest",
	"protocolProfileBehavior": {
	"disableBodyPruning": true
	},
	"request": {
	"method": "PUT",
	"header": [
	],
	"body": {
	"mode": "formdata",
	"formdata": [
	{
	"key": "Document",
	"type": "file",
	"src": "{{LocalFile}}"
	},
	{
	"key": "DocumentList",
	"type": "text",
	"value": "{\"DocumentEntries\":[{\"FileReference\":{\"Reference\":\"{{LocalFile}}\",\"Source\":\"Request\"},\"ImportFormatMode\":\"KeepSourceFormatting\"}]}"
	}
	]
	},
	"url": {
	"raw": "https://api.aspose.cloud/v4.0/words/online/put/appendDocument",
	"protocol": "https",
	"host": [
	"api",
	"aspose",
	"cloud"
	],
	"path": [
	"v4.0",
	"words",
	"online",
	"put",
	"appendDocument"
	],
	"query": [
	]
	}
	},
	"response": []
	}
	],
	"variable": [
	{ "key": "LocalFile", "value": "Sample.docx" }
	]
	}

view raw AppendDocumentOnline.json hosted with ❤ by GitHub

To get a JWT token use these instructions

How to merge several Word, PDF documents to a single document in Python, Java, C#, C++, JavaScript and other programming languages

Using SDK is the quickest way to speed up the development. Please take a look at the provided code examples to quickly call this web service from your favourite programming language:

	import os
	import asposewordscloud
	import asposewordscloud.models.requests
	from asposewordscloud.rest import ApiException
	from shutil import copyfile

	words_api = WordsApi(client_id = '####-####-####-####-####', client_secret = '##################')
	local_file= 'Sample.docx'

	request_document = open(local_file, 'rb')
	request_document_list_document_entries0_file_reference_stream = open(os.path.join(self.local_test_folder, local_file), 'rb')
	request_document_list_document_entries0_file_reference = asposewordscloud.FileReference.fromLocalFileContent(request_document_list_document_entries0_file_reference_stream)
	request_document_list_document_entries0 = asposewordscloud.DocumentEntry(file_reference=request_document_list_document_entries0_file_reference, import_format_mode='KeepSourceFormatting')
	request_document_list_document_entries = [request_document_list_document_entries0]
	request_document_list = asposewordscloud.DocumentEntryList(document_entries=request_document_list_document_entries)
	append_request = asposewordscloud.models.requests.AppendDocumentOnlineRequest(document=request_document, document_list=request_document_list)
	words_api.append_document_online(append_request)

	import com.aspose.words.cloud.*;
	import com.aspose.words.cloud.api.*;
	import com.aspose.words.cloud.model.*;
	import com.aspose.words.cloud.model.requests.*;
	import com.aspose.words.cloud.model.responses.*;
	import java.nio.file.Files;
	import java.nio.file.Paths;

	ApiClient apiClient = new ApiClient(/clientId/ "####-####-####-####-####", /clientSecret/ "##################", null);
	WordsApi wordsApi = new WordsApi(apiClient);
	String localFile = "Sample.docx";

	byte[] requestDocument = Files.readAllBytes(Paths.get(localFile).toAbsolutePath());
	byte[] requestDocumentListDocumentEntries0FileReferenceStream = Files.readAllBytes(Paths.get(TestInitializer.LocalTestFolder, localFile).toAbsolutePath());
	FileReference requestDocumentListDocumentEntries0FileReference = new FileReference(requestDocumentListDocumentEntries0FileReferenceStream);
	DocumentEntry requestDocumentListDocumentEntries0 = new DocumentEntry();
	requestDocumentListDocumentEntries0.setFileReference(requestDocumentListDocumentEntries0FileReference);
	requestDocumentListDocumentEntries0.setImportFormatMode("KeepSourceFormatting");

	ArrayList<DocumentEntry> requestDocumentListDocumentEntries = new ArrayList<DocumentEntry>();
	requestDocumentListDocumentEntries.add(requestDocumentListDocumentEntries0);

	DocumentEntryList requestDocumentList = new DocumentEntryList();
	requestDocumentList.setDocumentEntries(requestDocumentListDocumentEntries);

	AppendDocumentOnlineRequest appendRequest = new AppendDocumentOnlineRequest(requestDocument, requestDocumentList, null, null, null, null, null, null);
	wordsApi.appendDocumentOnline(appendRequest);

	import * as fs from "fs";

	const clientId = "####-####-####-####-####";
	const secret = "##################";
	const wordsApi = new WordsApi(clientId, secret);
	const localFile = "Sample.docx";

	const requestDocument = fs.createReadStream(localFile);
	const requestDocumentListDocumentEntries0FileReferenceStream = fs.createReadStream(BaseTest.localBaseTestDataFolder + localFile);
	const requestDocumentListDocumentEntries0FileReference = model.FileReference.fromLocalFileContent(requestDocumentListDocumentEntries0FileReferenceStream);
	const requestDocumentListDocumentEntries0 = new model.DocumentEntry({
	fileReference: requestDocumentListDocumentEntries0FileReference,
	importFormatMode: "KeepSourceFormatting"
	})
	const requestDocumentListDocumentEntries = [
	requestDocumentListDocumentEntries0
	]
	const requestDocumentList = new model.DocumentEntryList({
	documentEntries: requestDocumentListDocumentEntries
	})
	const appendRequest = new model.AppendDocumentOnlineRequest({
	document: requestDocument,
	documentList: requestDocumentList
	});

	wordsApi.appendDocumentOnline(appendRequest)
	.then((appendRequestResult) => {
	// tslint:disable-next-line:no-console
	console.log("Result of appendRequest: ", appendRequestResult);
	});

	using System;
	using System.Collections.Generic;
	using System.IO;
	using System.Linq;
	using System.Threading.Tasks;
	using Aspose.Words.Cloud.Sdk;
	using Aspose.Words.Cloud.Sdk.Model;
	using Aspose.Words.Cloud.Sdk.Model.Requests;

	var config = new Configuration { ClientId = "####-####-####-####-####", ClientSecret = "##################" };
	var wordsApi = new WordsApi(config);
	var localFile = "Sample.docx";

	using var requestDocument = File.OpenRead(localFile);
	using var requestDocumentListDocumentEntries0FileReferenceStream = File.OpenRead(LocalTestDataFolder + localFile);
	var requestDocumentListDocumentEntries0FileReference = new FileReference(requestDocumentListDocumentEntries0FileReferenceStream);
	var requestDocumentListDocumentEntries0 = new DocumentEntry()
	{
	FileReference = requestDocumentListDocumentEntries0FileReference,
	ImportFormatMode = "KeepSourceFormatting"
	};
	var requestDocumentListDocumentEntries = new List<DocumentEntry>()
	{
	requestDocumentListDocumentEntries0
	};
	var requestDocumentList = new DocumentEntryList()
	{
	DocumentEntries = requestDocumentListDocumentEntries
	};
	var appendRequest = new AppendDocumentOnlineRequest(requestDocument, requestDocumentList);
	await wordsApi.AppendDocumentOnline(appendRequest);

Merge several documents into one

Merge several Word, PDF documents to a single document REST API

Merge several Word, PDF documents to a single document usage examples

How to merge several Word, PDF documents to a single document with cURL or Postman

How to merge several Word, PDF documents to a single document in Python, Java, C#, C++, JavaScript and other programming languages

See Also