Resources to help developers integrate the web services
We want to help developers quickly leverage the SOAP and REST web services of webPDF and enable them to easily integrate PDF creation and processing into their own applications or enterprise solutions. Therefore, we provide various resources, documentations and examples to help you get started with webPDF.
Documentation (Developer Hub)
You can find webPDF's entire documentation online in the Developer Hub at https://docs.webpdf.de/. Have a look and get acquainted with the API web service without having to install the full version of webPDF.
Client-Integration
The “webpdf-wsclient” project provides you with a client integration that allows you to use the SOAP and REST web service API of webPDF directly. This client “wraps” the web service API of webPDF in a client in order to be able to use the web service functions directly in programming languages.
A description and examples of the “webpdf-client” can be found in the Developer Hub at https://docs.webpdf.de/docs/guides/development/wsclient/
The “webpdf-wsclient” is available for Java (https://github.com/softvision-dev/webpdf-wsclient) and Typescript (https://github.com/softvision-dev/webpdf-wsclient-typescript).
The client can be integrated directly into a project via the package managers Maven Repository and NPM.
Projects on GitHub
On GitHub, we provide various repositories to help developers use the webPDF web services quickly and easily with assets ranging from a simple implementation example all the way to complex application scenarios. Find out more at https://github.com/softvision-dev/.
Examples for programming languages
Under the GitHub project https://github.com/softvision-dev/webpdf-samples we provide examples for different programming languages (C#, Java, JavaScript, PHP, ...) to show and facilitate the integration of webPDF web services.
Server for development
To test the webPDF server or to connect an application, you need a running webPDF Server.
You can find the installation packages for the various platforms at https://docs.webpdf.de/docs/download/
The installation package for Windows can be found at https://download.softvision.de/?product=webpdf or you can integrate the server as package under Linux using our package manager.
Furthermore you can also start webPDF as a Docker Container if you use the image from the Docker Registry at https://hub.docker.com/r/softvisiondev/webpdf.
Also the use on VMware with the download at https://download.softvision.de/?product=webpdf_vm is easy to realize.
Online server
At https://portal.webpdf.de/webPDF you will find our demo server to try out webPDF and the API directly online, without having to perform an installation. You can also use this server to test the portal and the SOAP and REST web services directly online.
Description of the SOAP and REST API
To integrate the SOAP and REST web services, “stubs classes” are required in most cases, which “wrap” the actual call of the web service or the API and thus simplify it.
With SOAP web services, this can simply be created from the WSDL documents of the endpoints.
For the REST-API , we provide a similar definition based on Swagger or the OpenAPI, which makes it possible to create automatic wrapper classes for the API.
- Swagger UI: https://portal.webpdf.de/webPDF/help/restful/
- OpenAPI: JSON / YAML