Ressourcen für Entwickler zur Integration der Webservices

Wir wollen Entwicklern helfen, die SOAP- und REST-Webservices von webPDF schnell nutzen und so die Erstellung und Verarbeitung von PDF-Dokumenten einfach in eigene Anwendungen oder Unternehmenslösungen integrieren zu können. Daher stellen wir verschiedene Ressourcen, Dokumentationen und Beispiele zur Verfügung, die beim Einstieg in webPDF helfen sollen.

Projekte auf GitHub

Auf GitHub stellen wir verschiedene Repositories bereit, die Entwicklern helfen sollen, die webPDF-Webservices schnell und einfach zu nutzen - vom einfachen Einstiegsbeispiel bis zum komplexen Anwendungsszenario. Schauen Sie doch einfach mal unter https://github.com/softvision-dev/ vorbei.

Beispiele für Programmiersprachen

Unter dem GitHub Projekt https://github.com/softvision-dev/webpdf-samples stellen wir Beispiele für verschiedene Programmiersprachen (C#, Java, JavaScript, PHP,..) zur Verfügung, die eine Integration der webPDF Webservices zeigen und erleichtern sollen.

Client für Java

Mit dem Projekt "webpdf-wsclient" unter https://github.com/softvision-dev/webpdf-wsclient steht Ihnen eine Java-Integration zur Verfügung, mit der Sie die SOAP- und REST-Webservice API von webPDF direkt in Java nutzen können. Über das Maven Repository kann der Client direkt in ein Maven-Projekt eingebunden werden.

Dokumentation

Die komplette Dokumentation von webPDF finden Sie immer online unter https://www.webpdf.de/dokumentation. Schauen sie einfach mal rein, und lernen Sie die Webservice-API kennen, ohne webPDF komplett installieren zu müssen.

Server für die Entwicklung

Um den webPDF-Server zu testen oder eine Anwendung anzubinden, benötigen Sie einen laufenden webPDF-Server. Um diesen Server schnell bereitzustellen, können Sie webPDF als Installationspaket für Windows unter https://download.softvision.de/?product=webpdf herunterladen oder Sie binden den Server als Paket unter Linux über unseren Paketmanager ein. Darüber hinaus können Sie webPDF auch als Docker Container starten, wenn Sie das Image aus der Docker Registry unter https://hub.docker.com/r/softvisiondev/webpdf verwenden. Auch die Verwendung auf VMware mit dem Download unter https://download.softvision.de/?product=webpdf_vm ist einfach realisierbar.

Online-Server

Unter der Adresse https://portal.webpdf.de/webPDF finden Sie unseren Demo-Server, um webPDF und die API sofort online zu testen, ohne eine eigene Installation durchführen zu müssen. Sie können diesen Server verwenden, um das Portal und die SOAP- und REST-Webservices direkt online zu testen.

Beschreibung der SOAP- und REST-API

Zur Integration der SOAP- und REST-Webservices werden in den meisten Fällen "stubs classes" benötigt, die den eigentlichen Aufruf des Webservice "wrappen" und somit vereinfachen. Bei den SOAP-Webservices kann dies einfach aus den WSDL-Dokumenten der Endpunkte erstellt werden.

Bei der REST-API stellen wir auf Basis von Swagger eine ähnliche Definition bereit, die es ermöglicht, automatische Wrapper-Klassen für die API zu erstellen.

Schema

Die Parameter für die Webservices werden bei SOAP als XML und bei REST wahlweise als XML- oder JSON-Parameter übergeben. Die Definition und Prüfung der übergebenen Parameter findet auf Basis eines XSD-Schemas statt. Aus dem Schema können, je nach Programmiersprache, entsprechende Wrapper-Klassen generiert werden, was die Parameterübergabe vereinfacht.