RESTful Webservice API

Der webPDF-Server stellt seine Funktionen als RESTful-Webservices bereit. Es gibt sechs Webservices zur Ausführung der PDF-Funktionen des Servers. Zusätzlich gibt es einen Webservice, um den Dokumentenspeicher (Storage) für den Nutzer zu erstellen und einen Webservice, um die Dokumente im Storage zu verwalten.

 

Die Dokumentation der RESTful API finden Sie Online auf dem webPDF-Server unter http://localhost:8080/webPDF/help/restful/

 

Die Funktionen des webPDF-Server werden bei der RESTful API über Uniform Resource Identifier (URI) angesprochen. Die verschieden URI der Webservices sind über die HTTP-Methoden PUT, GET, POST und DELETE ausführbar.

 

Übergabe von Parametern

 

Der Datenaustausch der Webservices mit der Client-Anwendung, d.h. die Steuerung der Webservices mit Parametern, erfolgt über JSON (JavaScript Object Notation) (http://www.json.org/).

 

In den JSON-Datenstrukturen (Objekten) können mittels der einzelnen Elemente und Parametern mit Werten die Ausführung und das Verhalten der Webservices gesteuert werden.

 

Die Struktur der Daten ist als XML-Schema definiert (http://schema.webpdf.de/1.0/operation.xsd) und wird für die REST-API als entsprechende JSON-Struktur übernommen. Bei der Definition der Webservice-Parameter finden Sie jeweils zur XML-Struktur eine entsprechende JSON-Struktur für die Parameter abgebildet.

 

Bsp. einer JSON-Struktur beim Aufruf des Webservice "Converter"

 

{
"converter": {
  "pages": "*",
  "accessPassword": "xyz",
  "compression": true,
  "dpi": 300,
  "embedFonts": true,
  "jpegQuality": 90,
  "reduceResolution": true,
  "html": {
    "adjustFonts": true,
    "attachmentMode": "convert",
    "baseURL": "http://www.webpdf.net/",
    "downloadImages": true,

    "language":"en"
   }

 }
}

 

hint

Die Nutzung der REST-API können Sie am besten im Portal von webPDF verfolgen.

 

Die Beschreibung aller Übergabe- und Rückgabe-Parameter finden Sie in der Online-Dokumentation der RESTful API basierende auf dem Tool "Swagger" (http://swagger.io/).