Skip to main content
Version: 9.0

SOAP Web Service API

The webPDF server provides its functions in the form of SOAP 1.2 web services.

All SOAP web services are accessible via the base URL

http://localhost:8080/webPDF/soap

(replace "http://localhost:8080" with the address of your installed webPDF server if necessary).

The exact technical definition of the web services and the methods can be found under "Web Service WSDL Description“.

The webPDF server provides the following web services:

  • /converter -  File conversion to PDF format ( API {SOAP} )

  • /signature -  sign PDF documents ( API {SOAP} )

  • /pdfa - Convert PDF documents to PDF/A and validate existing PDF/A documents ( API {SOAP} )

  • /toolbox - Processing PDF documents (e.g. splitting, security, graphic export or printing) ( API {SOAP} )

  • /urlconverter - Conversion of HTML content retrieved via URL to PDF documents ( API {SOAP} )

  • /ocr - Optical text recognition of documents that are available as graphics and conversion to resolved PDF documents ( API {SOAP} )

  • /barcode - Recognition and generation of barcodes in PDF documents ( API {SOAP} )

The individual web services have SOAP methods (operations) which, together with the parameters (objects), can control the execution of the web services. In the objects, the execution and the behaviour of the web services can be influenced using the respective options and their parameters and values.

The communication of the SOAP web services is based on the exchange of XML data (via Internet protocols, such as HTTP) between the webPDF server and the client. Most programming languages and environments create proxy classes (“client stubs”) to use the web services, which simplifies their use. This takes place by calling the WSDL from the webPDF server in the respective environment.

The SOAP web service and its methods are provided via the proxy classes that were created. You will find a general description of the methods of the web services and their parameters below.