This example demonstrates how to convert word processing document into pdf document with adding watermark.
There are steps that usage of GroupDocs.Conversion Cloud consists of:
Upload input document into cloud storage
Convert document
Download converted document from storage
Steps 1 and 3 are storage operations, please refer to this for usage details.
Step 3 is not needed if the “OutputPath” option is not provided: the convert API method will return the converted document in the response body.
Name
Description
Comment
FileInfo.FilePath
The path of the document, located in the storage.
Required.
FileInfo.StorageName
Storage name
It could be omitted for default storage.
FileInfo.Password
The password to open file
It should be specified only for password-protected documents.
Resource URI
HTTP POST ~/conversion
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 convert documentcurl -v "https://api.groupdocs.cloud/v2.0/conversion/conversion"\
-X POST \
-H "Content-Type: application/json"\
-H "Accept: application/json"\
-H "Authorization: Bearer <jwt token>"-d "{
'FilePath': 'WordProcessing/four-pages.docx',
'Format': 'pdf',
'WatermarkOptions': {
'Text': 'Sample watermark',
'Color': 'Red',
'Width': 100,
'Height': 100,
'Background': true
}
'OutputPath': 'Output'
}"
Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us.
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet-samplesstringMyAppKey="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloudstringMyAppSid="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloudvarconfiguration=newConfiguration(MyAppSid,MyAppKey);// Create necessary API instancesvarapiInstance=newConvertApi(configuration);// Prepare convert settingsvarwatermark=newWatermarkOptions{Text="Sample watermark",Color="Red",Width=100,Height=100,Background=true};varsettings=newConvertSettings{FilePath="WordProcessing/four-pages.docx",Format="pdf",ConvertOptions=newPdfConvertOptions{WatermarkOptions=watermark},OutputPath="converted"};// Convert to specified formatvarresponse=apiInstance.ConvertDocument(newConvertDocumentRequest(settings));
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php-samples
useGroupDocs\Conversion\Model;useGroupDocs\Conversion\Model\Requests;$AppSid="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$AppKey="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$configuration=newGroupDocs\Conversion\Configuration();$configuration->setAppSid($AppSid);$configuration->setAppKey($AppKey);$apiInstance=newGroupDocs\Conversion\ConvertApi($configuration);// Prepare convert settings
$settings=newModel\ConvertSettings();$settings->setFilePath("WordProcessing/four-pages.docx");$settings->setFormat("pdf");$watermark=newModel\WatermarkOptions();$watermark->setText("Sample watermark");$watermark->setColor("Red");$watermark->setWidth(100);$watermark->setHeight(100);$watermark->setBackground(true);$convertOptions=newModel\PdfConvertOptions();$convertOptions->setWatermarkOptions($watermark);$settings->setConvertOptions($convertOptions);$settings->setOutputPath("converted");// Convert
$result=$apiInstance->convertDocument(newRequests\ConvertDocumentRequest($settings));
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java-samples
StringMyAppKey="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
StringMyAppSid="";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
Configurationconfiguration=newConfiguration(MyAppSid,MyAppKey);// Create API instance
ConvertApiapiInstance=newConvertApi(configuration);// Prepare convert settings
ConvertSettingssettings=newConvertSettings();settings.setFilePath("WordProcessing/four-pages.docx");settings.setFormat("pdf");WatermarkOptionswatermark=newWatermarkOptions();watermark.setText("Sample watermark");watermark.setColor("Red");watermark.setWidth(100);watermark.setHeight(100);watermark.setBackground(true);PdfConvertOptionsconvertOptions=newPdfConvertOptions();convertOptions.setWatermarkOptions(watermark);
# For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby-samplesrequire'groupdocs_conversion_cloud'$app_sid="XXXX-XXXX-XXXX-XXXX"# Get AppKey and AppSID from https://dashboard.groupdocs.cloud$app_key="XXXXXXXXXXXXXXXX"# Get AppKey and AppSID from https://dashboard.groupdocs.cloud# Create necessary API instancesapiInstance=GroupDocsConversionCloud::ConvertApi.from_keys($app_sid,$app_key)# Prepare convert settingswatermark=GroupDocsConversionCloud::WatermarkOptions.newwatermark.text="Sample watermark"watermark.color="Red"watermark.width=100watermark.height=100watermark.background=truesettings=GroupDocsConversionCloud::ConvertSettings.newsettings.file_path="WordProcessing/four-pages.docx"settings.format="pdf"convertOptions=GroupDocsConversionCloud::PdfConvertOptions.newconvertOptions.watermark_options=watermarksettings.convert_options=convertOptionssettings.output_path="converted"# Convertresult=apiInstance.convert_document(GroupDocsConversionCloud::ConvertDocumentRequest.new(settings))
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node-samples
global.conversion_cloud=require("groupdocs-conversion-cloud");global.appSid="XXXX-XXXX-XXXX-XXXX";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
global.appKey="XXXXXXXXXXXXXXXX";// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
global.convertApi=conversion_cloud.ConvertApi.fromKeys(appSid,appKey);letsettings=newconversion_cloud.ConvertSettings();settings.filePath="WordProcessing/four-pages.docx";settings.format="pdf";letwatermark=newconversion_cloud.WatermarkOptions();watermark.text="Sample watermark";watermark.color="Red";watermark.width=100;watermark.height=100;watermark.background=true;letconvertOptions=newconversion_cloud.PdfConvertOptions();convertOptions.watermarkOptions=watermark;settings.convertOptions=convertOptionssettings.outputPath="converted";letresult=awaitconvertApi.convertDocument(newconversion_cloud.ConvertDocumentRequest(settings));
# For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python-samplesimportgroupdocs_conversion_cloudapp_sid="XXXX-XXXX-XXXX-XXXX"# Get AppKey and AppSID from https://dashboard.groupdocs.cloudapp_key="XXXXXXXXXXXXXXXX"# Get AppKey and AppSID from https://dashboard.groupdocs.cloud# Create necessary API instancesapiInstance=groupdocs_conversion_cloud.ConvertApi.from_keys(Common.app_sid,Common.app_key)# Prepare convert settingssettings=groupdocs_conversion_cloud.ConvertSettings()settings.file_path="WordProcessing/four-pages.docx"settings.format="pdf"settings.convert_options=groupdocs_conversion_cloud.PdfConvertOptions()watermark=groupdocs_conversion_cloud.WatermarkOptions()watermark.text="Sample watermark"watermark.color="Red"watermark.width=100watermark.height=100watermark.background=Truesettings.watermark_options=watermarksettings.output_path="converted"# Convertresult=apiInstance.convert_document(groupdocs_conversion_cloud.ConvertDocumentRequest(settings))
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples
packagecommonimport("fmt""github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples/config""github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go/models")funcAddWatermark(){watermark:=models.WatermarkOptions{Text:"Sample watermark",Color:"Red",Width:100,Height:100,Background:true,}settings:=models.ConvertSettings{Format:"pdf",FilePath:"WordProcessing/four-pages.docx",OutputPath:"converted",ConvertOptions:&models.PdfConvertOptions{WatermarkOptions:&watermark,},}result,_,err:=config.Client.ConvertApi.ConvertDocument(config.Ctx,settings)iferr!=nil{fmt.Printf("AddWatermark error: %v\n",err)return}fmt.Printf("Document converted successfully: %v\n",result[0].Url)}
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.