Webservice Documents

Bei den RESTful-Webservices benutzt der webPDF-Server einen "Dokumentenspeicher" (Storage) auf dem Server, um die zu bearbeitende Dokumente zwischen den einzelnen Webservice-Aufrufen zu speichern.

 

Dieser Storage wird pro Benutzer (Session) verwaltet und wird einem Token zugeordnet. Der Token wird über den Webservice "Authentication" initialisiert. Wird eine Session beendet (Logout) oder läuft ab (Timeout), wird der Token ungültig, der Storage entfernt und alle Dokumenten darin auf dem Server gelöscht.

 

Um den Storage zu benutzen, stellt der webPDF-Server einen Webservice mit dem URI

 

/webPDF/rest/documents/...

 

zur Verfügung. Mit entsprechenden HTTP-Operation wie z.B. POST oder GET, können Dokumente auf den Storage geladen oder von dort herunter geladen werden.

 

Dokumenten-ID

 

Jedes Dokument, das in dem Storage gespeichert ist, bekommt eine eindeutige ID (Unique "documentId"). Diese ID wird bei

 

POST /webPDF/rest/documents

 

erstellt und in der JSON-Antwort des Webservice mitgeliefert. Diese ID wird dann in der URI der Webservices zur Ausführung von PDF-Funktionen zur Auswahl des Dokuments benötigt.

 

Beispiel:

 

Upload eines Dokuments (Parameter Type "formData") mit

 

POST /webPDF/rest/documents

 

führt zu folgender JSON-Struktur

 

[
 {
  "documentId": "67b4e25d3c1a498e9b5a7f8221b2bf0c",
  "parentDocumentId": "",
  "fileSize": 12640,
  "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "fileName": "sample",
  "fileExtension": "docx",
  "fileTypeId": 1336,
  "fileTypeGroups": "OFFICE,WORD",
  "fileLastModified": "Tue, 06 Jun 2017 08:13:47 GMT",
  "numberOfPages": 0,
  "hasPermissionPassword": true,
  "hasOpenPassword": true,
  "isFileLocked": false,
  "hasSignature": false,
  "pdfaLevel": "",
  "formType": "",
  "metadata": ""
 }
]

 

Um dieses Dokument zu konvertieren, wird der Webservice "Converter" mit der "documentId" im URI aufgerufen:

 

POST /webPDF/rest/converter/67b4e25d3c1a498e9b5a7f8221b2bf0c

 

Um Informationen über das Dokument im Storage zu erhalten (z.B. Anzahl der Seiten), wird folgendes aufgerufen:

 

DELETE /webPDF/rest/documents/67b4e25d3c1a498e9b5a7f8221b2bf0c/info

 

Danach steht in der JSON-Struktur (siehe oben) unter "numberOfPages" die Anzahl der Seiten im PDF-Dokument.

 

Um dieses Dokument dann aus dem Storage zu löschen, wird

 

DELETE /webPDF/rest/documents/67b4e25d3c1a498e9b5a7f8221b2bf0c

 

aufgerufen.