SOAP Web Services
webPDF provides its interfaces as SOAP 1.2 web services (http://www.w3.org/TR/soap) in accordance with the "Java Specification Request (JSR) 224." The interface description is provided as a "Web Services Description Language (WSDL)" (http://www.w3.org/TR/wsdl).
The webPDF server provides the SOAP web services based on "JAX-WS 2.2" (https://jax-ws.java.net/) and the "JAX-WS Reference Implementation (RI) Project" (https://jax-ws.java.net/) in version 2.2.8.
The message schema of the messages that are exchanged via the SOAP interface is described in greater detail below. The messages exchanged with SOAP are based on the XML Schema Definition (XSD) language.
All together this forms the webPDF SOAP API, which is described generally under "SOAP Web Service API" and technically under "API {SOAP}".
Documentation as WSDL
All web services of the SOAP API are described as Web Services Description Language (WSDL). The WSDL definition can be accessed by adding "?WSDL" to the service URL of a running webPDF server.
URI of the web services
All URI have the shared base URL
/webPDF/soap
After this comes the URL segment for the respective web service.
An overview of the web services provided with their base URI is shown below:
The specification of the server (in the following URLs “localhost”) may have to be replaced by a corresponding server address (IP or Internet domain) if the call of the address does not occur from the same computer on which the webPDF server has been installed.
The URL for the converter service is:
http://localhost:8080/webPDF/soap/converter?wsdl
The URL for the signature service is:
http://localhost:8080/webPDF/soap/signature?wsdl
The URL for the Pdfa service is:
http://localhost:8080/webPDF/soap/pdfa?wsdl
The URL for the Toolbox service is:
http://localhost:8080/webPDF/soap/toolbox?wsdl
The URL for the URLConverter service is:
http://localhost:8080/webPDF/soap/urlconverter?wsdl
The URL for the OCR service is:
http://localhost:8080/webPDF/soap/ocr?wsdl
The URL for the barcode service is:
http://localhost:8080/webPDF/soap/barcode?wsdl
Parameters for controlling the web services
In SOAP web services, the parameters are passed in XML structures that are included in the "body" (payload) of the request.
Proxy classes for the web services
Most programming languages provide tools that can generate the proxy classes (so-called "client stubs“) for this interface or the WDSL definition. A client application can access the web services by using these classes.
If these tools are not available, then the SOAP-XML messages can be created directly / the responses can be parsed. The messages have to be created and interpreted according to the SOAP and WSDL specifications that are delivered as a part of the WSDL definition.