Skip to main content
Version: 9.0

OpenAPI

webPDF describes its REST API via the OpenAPI specification of the OpenAPI Initiative in version 3.

The webPDF REST API is available online on our server as SwaggerUI at https://portal.webpdf.de/webPDF/help/restful/ or the (local) installed webPDF server at http://localhost:8080/webPDF/help/restful/.

As JSON or YAML syntax, the specification for the webPDF REST API is available at

https://portal.webpdf.de/webPDF/rest/openapi.json (bzw. lokal http://localhost:8080/webPDF/rest/openapi.json)

or

https://portal.webpdf.de/webPDF/rest/openapi.yaml (bzw. lokal http://localhost:8080/webPDF/rest/openapi.yaml)

With the OpenAPI specification for the webPDF REST API, integration into different programming languages can be easily done using the OpenAPI Generator or the online "Swagger Editor". The OpenAPI Generator creates the appropriate "wrappers" from the specification for different programming languages or frameworks to call the endpoints of the webPDF REST API.