SOAP Webservices

webPDF stellt seine Schnittstellen (Interface) als SOAP 1.2 Webservices (http://www.w3.org/TR/soap) gemäß der "Java Specification Request (JSR) 224" zur Verfügung. Die Beschreibung des Interface wird als "Web Services Description Language (WSDL)" (http://www.w3.org/TR/wsdl) zur Verfügung gestellt.

 

Der webPDF-Server stellt die SOAP-Webservices auf Basis "JAX-WS 2.2" (https://jax-ws.java.net/) und dem "JAX-WS Reference Implementation (RI) Project" (https://jax-ws.java.net/) in der Version 2.2.8 bereit.

 

Das Schema der Nachrichten, die über das SOAP-Interface ausgetauscht werden, wird in der Folge näher erläutert. Die über SOAP ausgetauschten Nachrichten basieren auf der XML Schema Definition (XSD) Sprache.

 

Als dies zusammen bildet die webPDF SOAP API, die unter "SOAP Webservice API" beschrieben wird.

 

 

Dokumentation

 

Die WSDL-Definition kann von einem laufenden webPDF-Server durch Anhängen von "?WSDL" an die Service-URL abgerufen werden.

 

Die Angabe des Servers (in den nachfolgenden URLs "localhost") muss ggf. durch eine entsprechende Server-Adresse (IP oder Internet-Domain) ersetzt werden, wenn der Aufruf der Adresse nicht von dem gleichen Rechner erfolgt, wo auch der webPDF-Server installiert wurde.

 

Für den Konverter-Service lautet die URL wie folgt:

http://localhost:8080/webPDF/soap/converter?wsdl

 

Für den Signatur-Service lautet die URL wie folgt:

http://localhost:8080/webPDF/soap/signature?wsdl

 

Für den Pdfa-Service lautet die URL wie folgt:

http://localhost:8080/webPDF/soap/pdfa?wsdl

 

Für den Toolbox-Service lautet die URL wie folgt:

http://localhost:8080/webPDF/soap/toolbox?wsdl

 

Für den URLConverter-Service lautet die URL wie folgt:

http://localhost:8080/webPDF/soap/urlconverter?wsdl

 

Für den OCR-Service lautet die URL wie folgt:

http://localhost:8080/webPDF/soap/ocr?wsdl

 

Für den Barcode-Service lautet die URL wie folgt:

http://localhost:8080/webPDF/soap/barcode?wsdl

 

 

Parameter zur Steuerung der Webservices

 

Bei den SOAP-Webservices werden die Parameter in XML-Strukturen übergeben, die im "Body" der Anfrage enthalten sind.

 

 

Proxy-Klassen für die Webservices

 

Die meisten Programmiersprachen verfügen über Tools, die entsprechende Proxy-Klassen (sogenannte "client stubs") für dieses Interface bzw. die WSDL-Definition generieren können. Mit diesen Klassen kann dann eine Client-Anwendung die Webservices verwenden (siehe "Beispiele").

 

Sollten solche Tools nicht verfügbar sein, dann besteht die Möglichkeit, die SOAP-XML-Nachrichten direkt zu erstellen bzw. die Antworten zu "parsen". Die Nachrichten sind gemäß der SOAP- und WSDL- Spezifikation, die als Teil der WSDL-Definition geliefert werden, zu erstellen bzw. zu interpretieren.