GroupDocs.Signature Cloud provides a method to update some signature properties by it’s id. The signature ID is needed to perform the update, it comes from the result of sign or search operation.
API usage
There are steps that usage of GroupDocs.Signature Cloud consists of:
Upload input document into cloud storage
Update signatures
Download output document
For storage operations, like uploading or downloading documents, please refer to the corresponding articles of this manual.
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"\-XPOST\-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 get document information
curl-v"https://api.groupdocs.cloud/v2.0/signature/update"\-XPOST\-H"Content-Type: application/json"\-H"Accept: application/json"\-H"Authorization: Bearer <jwt token>"-d"{
'FileInfo': {
'FilePath': 'signedBarcode_one-page.docx'
},
'Options': [
{
'SignatureType': 'Barcode',
'SignatureId': '4cb67aa8-835d-4877-8a5d-5a9ad015a098',
'Left': 200,
'Top': 200,
'Width': 300,
'Height': 100,
'IsSignature': true
}
]
}"
The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.
// For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-dotnet-samplesstringMyClientSecret="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudstringMyClientId="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudvarconfiguration=newConfiguration(MyClientId,MyClientSecret);varapiInstance=newSignApi(configuration);// Search barcode signature to get IDvarsearchBarcodeOptions=newSearchBarcodeOptions{SignatureType=SignatureTypeEnum.Barcode,MatchType=SearchBarcodeOptions.MatchTypeEnum.Contains,Text="123456789012",BarcodeType="Code128",AllPages=true};// Search settings.varsearchSettings=newSearchSettings{FileInfo=newFileInfo{FilePath="signedBarcode_one-page.docx",},Options=newList<SearchOptions>{searchBarcodeOptions}};// Call api method with request.varsearchResult=apiInstance.SearchSignatures(newSearchSignaturesRequest(searchSettings));// Update optionsvaroptions=newUpdateOptions{SignatureType=UpdateOptions.SignatureTypeEnum.Barcode,Left=200,Top=200,Width=300,Height=100,IsSignature=true,SignatureId=searchResult.Signatures[0].SignatureId};// Update settingsvarupdateSettings=newUpdateSettings{FileInfo=newFileInfo{FilePath="signedBarcode_one-page.docx"},Options=newList<UpdateOptions>{options}};// Create requestvarrequest=newUpdateSignaturesRequest(updateSettings);// Call api method with requestvarresponse=apiInstance.UpdateSignatures(request);
// For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-java-samples
StringMyClientSecret="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
StringMyClientId="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
Configurationconfiguration=newConfiguration(MyClientId,MyClientSecret);SignApiapiInstance=newSignApi(configuration);FileInfofileInfo=newFileInfo();fileInfo.setFilePath("Signaturedocs\\signedBarcodeOne_page.docx");InfoSettingsinfoSettings=newInfoSettings();infoSettings.setFileInfo(fileInfo);SearchBarcodeOptionsoptions=newSearchBarcodeOptions();options.setSignatureType(SignatureTypeEnum.BARCODE);options.setAllPages(true);SearchSettingssearchSettings=newSearchSettings();searchSettings.setFileInfo(fileInfo);searchSettings.addOptionsItem(options);SearchSignaturesRequestrequest=newSearchSignaturesRequest(searchSettings);SearchResultsearchResult=apiInstance.searchSignatures(request);UpdateOptionsupdateOptions=newUpdateOptions();updateOptions.setSignatureType(UpdateOptions.SignatureTypeEnum.BARCODE);updateOptions.setLeft(200);updateOptions.setTop(200);updateOptions.setWidth(300);updateOptions.setHeight(100);updateOptions.setIsSignature(true);updateOptions.setSignatureId(searchResult.getSignatures().get(0).getSignatureId());UpdateSettingsupdateSettings=newUpdateSettings();updateSettings.setFileInfo(fileInfo);updateSettings.addOptionsItem(updateOptions);UpdateResultupdateResult=apiInstance.updateSignatures(newUpdateSignaturesRequest(updateSettings));
// For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-php-samples
useGroupDocs\Signature\Model;useGroupDocs\Signature\Model\Requests;$ClientId="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
$ClientSecret="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
$configuration=newGroupDocs\Signature\Configuration();$configuration->setAppSid($ClientId);$configuration->setAppKey($ClientSecret);$apiInstance=newGroupDocs\Signature\SignApi($configuration);$fileInfo=newGroupDocs\Signature\Model\FileInfo();$fileInfo->setFilePath("signaturedocs\signedBarcodeOne_page.docx");// Search
$settings=newGroupDocs\Signature\Model\SearchSettings();$settings->setFileInfo($fileInfo);$options=newGroupDocs\Signature\Model\SearchBarcodeOptions();$options->setPage(1);$options->setAllPages(false);$options->setSignatureType(GroupDocs\Signature\Model\OptionsBase::SIGNATURE_TYPE_BARCODE);$settings->setOptions([$options]);$request=newGroupDocs\Signature\Model\Requests\SearchSignaturesRequest($settings);$response=$apiInstance->searchSignatures($request);// Update
$updateSettings=newGroupDocs\Signature\Model\UpdateSettings();$updateSettings->setFileInfo($fileInfo);$updateOptions=newGroupDocs\Signature\Model\UpdateOptions();$updateOptions->setSignatureType(GroupDocs\Signature\Model\UpdateOptions::SIGNATURE_TYPE_BARCODE);$updateOptions->setSignatureId($response->getSignatures()[0]->getSignatureId());$updateOptions->setIsSignature(true);$updateOptions->setLeft(200);$updateOptions->setTop(200);$updateOptions->setWidth(300);$updateOptions->setHeight(100);$updateSettings->setOptions([$updateOptions]);$request=newGroupDocs\Signature\Model\Requests\UpdateSignaturesRequest($updateSettings);$response=$apiInstance->updateSignatures($request);
// For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-node-samples
global.signature_cloud=require("groupdocs-signature-cloud");global.clientId="XXXX-XXXX-XXXX-XXXX";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
global.clientSecret="XXXXXXXXXXXXXXXX";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
global.signApi=signature_cloud.SignApi.fromKeys(clientId,clientSecret);letfileInfo=newsignature_cloud.FileInfo();fileInfo.filePath="signaturedocs/signedBarcodeOne_page.docx";// Search
letopts=newsignature_cloud.SearchBarcodeOptions();opts.signatureType=signature_cloud.OptionsBase.SignatureTypeEnum.Barcode;opts.matchType=signature_cloud.SearchBarcodeOptions.MatchTypeEnum.Contains;opts.allPages=true;letsettings=newsignature_cloud.SearchSettings();settings.fileInfo=fileInfo;settings.options=[opts];letrequest=newsignature_cloud.SearchSignaturesRequest(settings);letresponse=awaitsignApi.searchSignatures(request);console.log("signatureId = "+response.signatures[0].signatureId);// Update
letupdateOpts=newsignature_cloud.UpdateOptions();updateOpts.signatureType=signature_cloud.UpdateOptions.SignatureTypeEnum.Barcode;updateOpts.signatureId=response.signatures[0].signatureId;updateOpts.left=200;updateOpts.top=200;updateOpts.width=300;updateOpts.height=100;updateOpts.isSignature=true;letupdateSettings=newsignature_cloud.UpdateSettings();updateSettings.fileInfo=fileInfo;updateSettings.options=[updateOpts];request=newsignature_cloud.UpdateSignaturesRequest(updateSettings);response=awaitsignApi.updateSignatures(request);
# For complete examples and data files, please go to https://github.com/groupdocs-signature_cloud-cloud/groupdocs-signature_cloud-cloud-python-samplesfromgroupdocs_signature_cloudimport*importgroupdocs_signature_cloudclient_id="XXXX-XXXX-XXXX-XXXX"# Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudclient_secret="XXXXXXXXXXXXXXXX"# Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudapi=groupdocs_signature_cloud.SignApi.from_keys(client_id,client_secret)fileInfo=FileInfo()fileInfo.file_path="signaturedocs\\signedBarcodeOne_page.docx"# Searchopts=SearchBarcodeOptions()opts.page=1opts.signature_type='Barcode'settings=SearchSettings()settings.options=[opts]settings.file_info=fileInforequest=SearchSignaturesRequest(settings)response=api.search_signatures(request)# Updateopts=UpdateOptions()opts.page=1opts.signature_type='Barcode'opts.signature_id=response.signatures[0].signature_idopts.left=200opts.top=200opts.width=300opts.height=100opts.is_signature=Truesettings=UpdateSettings()settings.options=[opts]settings.file_info=fileInforequest=UpdateSignaturesRequest(settings)response=api.update_signatures(request)
# For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-ruby-samplesrequire'groupdocs_signature_cloud'$client_id="XXXX-XXXX-XXXX-XXXX"# Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud$client_secret="XXXXXXXXXXXXXXXX"# Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudapi=GroupDocsSignatureCloud::SignApi.from_keys($client_id,$client_secret)$info=GroupDocsSignatureCloud::FileInfo.new()$info.file_path="signaturedocs\\signedBarcodeOne_page.docx"# Search$opts=GroupDocsSignatureCloud::SearchBarcodeOptions.new()$opts.signature_type="Barcode"$opts.all_pages=true$settings=GroupDocsSignatureCloud::SearchSettings.new()$settings.options=[$opts]$settings.file_info=$info$request=GroupDocsSignatureCloud::SearchSignaturesRequest.new($settings)$response=api.search_signatures($request)# Update$updateOpts=GroupDocsSignatureCloud::UpdateOptions.new()$updateOpts.signature_type="Barcode"$updateOpts.signature_id=$response.signatures[0].signature_id$updateOpts.left=200$updateOpts.top=200$updateOpts.width=300$updateOpts.height=100$updateOpts.is_signature=true$updateSettings=GroupDocsSignatureCloud::UpdateSettings.new()$updateSettings.options=[$updateOpts]$updateSettings.file_info=$info$request=GroupDocsSignatureCloud::UpdateSignaturesRequest.new($updateSettings)$response=api.update_signatures($request)
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.