RESTful Webservices

webPDF stellt seine Schnittstellen (Interface) als RESTful-Webservices gemäß der "Java Specification Request (JSR) 311" (https://jsr311.java.net/) zur Verfügung. Die Bereitstellung basiert auf den Web-Standards und dem HTTP-Protokoll.

 

Die Funktionen von webPDF werden als REST (Representational State Transfer) Ressourcen bereitgestellt und können über einen Uniform Resource Identifier (URI) angesprochen werden. Die Darstellung der Ressourcen erfolgt in JSON (http://www.json.org/).

 

Der webPDF-Server stellt die RESTful-Webservices auf Basis JAX-RS 2.0 (https://jax-rs-spec.java.net/) und der Jersey-Referenzimplementierung (https://jersey.java.net/) bereit.

 

Die verschieden URI der Webservices sind über die HTTP-Methoden PUT, GET, POST und DELETE ausführbar.

 

 

Dokumentation

 

Eine detaillierte Beschreibung der URI, der entsprechenden HTTP-Methoden und Parameter sind direkt vom laufenden webPDF-Server abrufbar:

 

http://localhost:8080/webPDF/help/restful/

 

Die Angabe des Servers in der URL muss ggf. durch eine entsprechende Server-Adresse (IP oder Internet-Domain) ersetzt werden, wenn der Aufruf der Adresse nicht von dem gleichen Rechner erfolgt, wo auch der webPDF-Server installiert wurde.

 

Die Dokumentation wird automatisiert durch das Tool "Swagger" (http://swagger.io/) bereitgestellt und visuell aufbereitet. Zur automatisierten Verarbeitung oder Import in Entwicklerwerkzeuge, kann diese auch direkt als JSON oder YAML-Struktur abgerufen werden:

 

http://localhost:8080/webPDF/rest/swagger.json

http://localhost:8080/webPDF/rest/swagger.yaml

 

 

URI der Webservices

 

Alle URI haben die gemeinsame Basis-URL

 

/webPDF/rest

 

Danach folgt das URL-Segment für den jeweiligen Webservice, gefolgt von weiteren Segmenten, die Webservice-spezifisch sind. Nachfolgend eine Übersicht, über die bereitgestellten Webservices mit Ihren Basis-URI:

 

Webservice

URI

Converter

/webPDF/rest/converter/...

Signature

/webPDF/rest/signature/...

Pdfa

/webPDF/rest/pdfa/...

Toolbox

/webPDF/rest/toolbox/...

URLConverter

/webPDF/rest/urlconverter/...

OCR

/webPDF/rest/ocr/...

Barcode

/webPDF/rest/barcode/...

 

Darüber hinaus existieren zwei URI, die für die Verwaltung der Dokumente (Webservice "documents") und der Anmeldung (Webservice "authentication") dienen.