SOAP Webservice API

Der webPDF-Server stellt seine Funktionen (Operationen) als SOAP 1.2 Webservices bereit. Alle SOAP-Webservices sind über die Basis-URL

 
http://localhost:8080/webPDF/soap

 

erreichbar (ersetzen Sie ggf. "http://localhost:8080" durch die Adresse ihres installierten webPDF-Servers)

 

Die genaue technische Definition der Webservices und der Methoden kann der "Webservice WSDL-Beschreibung" entnommen werden.

 

Der webPDF-Server stellt unter der Basis-URL die folgenden Webservices als SOAP-API zur Verfügung:

 

/converter - Dateikonvertierung in das PDF-Format

 

/signature - Digitales Signieren von Dokumenten

 

/pdfa - Konvertieren von PDF-Dokumenten nach PDF/A und Validieren von bestehenden PDF/A-Dokumenten

 

/toolbox - Verarbeiten von PDF-Dokumenten (z. B. Aufteilung, Sicherheit, Grafikexport oder Drucken)

 

/urlconverter - Konvertierung von HTML-Inhalten, die per URL abgerufen werden, in PDF-Dokumente

 

/ocr - Optische Texterkennung von Dokumenten, die als Grafik vorliegen, und Umwandlung in aufgelöste PDF-Dokumente

 

/barcode - Erkennung von Barcodes in Dokumenten im PNG-, JPEG- oder PDF-Format und Erstellung von Barcodes verschiedener Formate in PDF-Dokumenten

 

Zusammenfassend bilden die Webservices die SOAP-API des webPDF-Servers.

 

Die einzelnen Webservices verfügen über SOAP-Methoden (Operationen), die mit den Parametern (Objekten) die Ausführung der Webservices steuern können. In den Objekten wird über entsprechende Optionen mittels Parametern und Werten die Ausführung und das Verhalten der Webservices beeinflusst.

 

Die Kommunikation bei den SOAP-Webservices basiert auf dem Austausch von XML-Daten (über Internet-Protokolle, wie z.B. HTTP) zwischen dem webPDF-Server und dem Client. Die meisten Programmiersprachen bzw. Umgebungen erstellen für die Nutzung der Webservices Proxy-Klassen ("client stubs"), um die Nutzung zu vereinfachen. Dies erfolgt durch den Abruf der WSDL vom webPDF-Server in der jeweiligen Umgebung.

 

Über die erstellten Proxy-Klassen werden die SOAP-Webservices und ihre Methoden bereitgestellt. Nachfolgend finden Sie die allgemeine Beschreibung der Methoden der Webservices und deren Parameter.