This REST API allows merging two or more documents into a single resultant document.
For the simplest scenario of combining several documents together it’s only needed to provide storage path for each file. For protected documents, it is also required to provide a password.
The table below contains the full list of properties that can be specified for each joined document.
Name
Description
Comment
FilePath
The file path in the storage
Required property
StorageName
Storage name
It could be omitted for default storage.
VersionId
File version Id
Useful for storages that support file versioning
Password
The password to open file
Should be specified only for password-protected documents
OutputPath
Path to resultant document
Required
Resource URI
HTTP POST ~/join
Swagger UI lets you call this REST API directly from the browser.
cURL example
* First get JSON Web Token
* Please get your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications. Kindly place Client Id in "client_id" and Client Secret in "client_secret" argument.
curl -v "https://api.groupdocs.cloud/connect/token"\
-X POST \
-d "grant_type=client_credentials&client_id=xxxx&client_secret=xxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
-H "Accept: application/json"* cURL example to join several documents into one
curl -v "https://api.groupdocs.cloud/v1.0/merger/join"\
-X POST \
-H "Content-Type: application/json"\
-H "Accept: application/json"\
-H "Authorization: Bearer
<jwt token>"-d "{
'JoinItems':
[
{
'FileInfo':
{
'FilePath': '/WordProcessing/four-pages.docx',
'Password': 'password'
}
},
{
'FileInfo':
{
'FilePath': '/WordProcessing/one-page.docx'
}
}
],
'OutputPath': 'output/joined.docx'
}"
Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of makingRequests and handlingResponses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of GroupDocs.Merger Cloud SDKs along with working examples, to get you started in no time. Please check the article to learn how to add an SDK to your project.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.