Zum Hauptinhalt springen

Webservices

webPDF stellt seine PDF-Funktionen als SOAP- oder REST-Webservices zur Verfügung. Die Webservices können von jeder Plattform, die mit Webservices kommunizieren kann, verwendet werden. Darüber hinaus lassen sich die Webservices in Programmiersprachen integrieren, um dort die Funktionen von webPDF zu nutzen. Die SOAP- und REST-Webservices bilden die SOAP- bzw. REST-API des webPDF-Servers.

Tipp

Eine Referenz-Implementierung der Webservices stellt der webPDF wsclient zur Verfügung.

Webservice API​

Nachfolgend wird die webPDF-Schnittstelle beschrieben:

Unabhängig von der verwendeten (technischen) Schnittstelle (SOAP- oder REST) stellt der webPDF-Server die nachfolgenden Operationen zur Verfügung, um die PDF-Funktionen von webPDF zu benutzen und Dokumente zu erstellen oder zu bearbeiten:

  • "Converter" - Dateikonvertierung in das PDF-Format ( API {REST} / API {SOAP} )
  • "Signature" - Digitales Signieren von Dokumenten ( API {REST} / API {SOAP} )
  • "Pdfa" - Konvertieren von PDF-Dokumenten nach PDF/A und Validieren von bestehenden PDF/A-Dokumenten ( API {REST} / [API {SOAP}]../../soapapi#pdfa.element.operation) )
  • "Toolbox" - Verarbeiten von PDF-Dokumenten (z. B. Aufteilung, Sicherheit, Grafikexport oder Drucken) ( API {REST} / API {SOAP} )
  • "URLConverter" - Konvertierung von HTML-Inhalten, die per URL abgerufen werden, in PDF-Dokumente ( API {REST} / API {SOAP} )
  • "OCR" - Optische Texterkennung von Dokumenten, die als Grafik vorliegen, und Umwandlung in aufgelöste PDF-Dokumente ( API {REST} / API {SOAP} )
  • "Barcode" - Erkennung und Generierung von Barcodes in PDF-Dokumenten ( API {REST} / API {SOAP} )

Je nach verwendeter Technik werden die SOAP- bzw. REST-Webservices mit unterschiedlichen URLs bzw. URI aufgerufen.

Hinweis

Die REST-API stellt eine Reihe von weiteren Endpunkten zur Verfügung, die zur Anmeldung und dem Dokumenten-Management verwendet werden.

Steuerung der Webservices​

Bei allen Webservices erfolgt die Steuerung über Parameter, die als XML- (bei der SOAP-API) bzw. JSON-Strukturen (bei der REST-API) definiert sind. Die Parameter werden als "Payload" im Body des HTTP Requests übergeben.

Für jeden Webservice existieren individuelle Parameter, die in der jeweiligen technischen Dokumentation der API dokumentiert sind.

Mit den Parametern kann das Verhalten und die Ausführung der Webservices gesteuert werden. Die Parameter sind dabei identisch, egal, ob Sie die SOAP- oder REST-Webservices verwenden.