Parameters
The REST web services and their behavior are controlled via parameters that are transferred as JSON structures in the payload of the HTTP request (e.g. HTTP POST).
POST http://localhost:8080/webPDF/rest/converter/26fe0636b6044c2aa0cbfeb1fd5a795e
Example: Webservice Converter to convert a document
{
"converter": {
"pages": "*",
"embedFonts": true,
"jpegQuality": 90,
"reduceResolution": true
}
}
Depending on the web service operation being executed, there are different parameters. As an example, here is the web service converter with its parameters in the JSON object converter.
All pages (pages) are converted, the fonts are embedded (embedFonts) and the image resolution of graphics is reduced to 90% (jpedQuality and reduceResolution).
The description of all parameters can be found in the API documentation, in this case in the Webservice "Converter".
Please note that each web service has its own parameters. The meaning and options of the respective parameters can be found in the API documentation for the respective web service.
Each web service has its own object in the JSON structure under which the parameters are transferred. For the PDF/A web service, for example, this is pdfa and for the barcode web service barcode.
Settings
The JSON object settings, which is available in the web service group operations, allows you to override the server's general server settings on a per-request basis.
In the following examples, the web service converter is always referenced, but the information also applies to other web services such as pdfa or toolbox.
{
"converter": {
... other options ...
},
"settings": {
"compress": {
...
},
"http": {
...
},
"pdfa": {
...
},
"signature": {
...
}
}
}
These are the areas
A detailed description of the settings can be found under server settings.
Document protection
The JSON objects pdfa and signature are used to define document protection. This allows the protection of PDF/A documents or documents with digital signatures, which is activated by default, to be adjusted or removed. These parameters can be used to set how the web service should be executed when a PDF/A document (pdfa) or a digital signature (signature) is to be processed in the web service call.
If protection is active, the web service call will return an error code (e.g. error code -5038 or -5040) if a PDF document is to be processed. If the protection is "switched off", the PDF document is changed, even if this results in the PDF/A standard being violated or a digital signature becoming invalid.
This setting option is available for all web service calls that process a PDF document and only applies to the call in which the parameters are set. The parameters under settings are set separately for PDF/A documents (pdfa) and digitally signed documents (signature).
To remove the protection completely, for example, you can set the option noEditRestrictions in the parameter pdfa or signature using pdfaEditProfile or signatureEditProfile.
If document protection is removed, it is the responsibility of the web service caller to ensure that the PDF/A document and/or digital signatures are handled correctly.
Example in the JSON structure to remove protection for PDF/A and digital signatures:
{
"converter": {
... other options ...
},
"settings": {
"pdfa": {
"pdfaEditProfile": "noEditRestrictions"
},
"signature": {
"signatureEditProfile": "noEditRestrictions"
}
}
}