Category: Rest API

Download the PDF as html/svg GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/content Accept: text/html

Download the PDF as a tiff GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/content?dpi=300 Accept: image/tiff

Get annotations GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/annotations?pageIndex=0 Export annotations GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/annotations/content Accept: application/xfdf Import annotations POST http://{host}:{port}/qoppapdf/v1/documents/mydir/otherdoc.pdf/annotations Content-Type: application/xfdf (xfdf file in message body) Flatten annotations POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf (sample JSON in message body) { “FlattenAnnotationsAction”: { “paintNonPrintableAnnots”: true, “savePath”: “flatAnnots/mydoc.pdf” } }

Get form fields GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields Export form fields GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/content?exportEmptyFields=true Accept: application/xfdf Import form fields POST http://{host}:{port}/qoppapdf/v1/documents/mydir/otherdoc.pdf/fields Content-Type: application/xfdf (xfdf file in message body) Flatten form fields POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf (sample JSON in message body) { “FlattenFieldsAction”: { “paintButtons”: true, “paintOnlyImageButtons”: true, “paintNonPrintableFields”: true, “savePath”: “flatFields/mydoc.pdf” } }

Download a single page as an image GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/pages/0/content?dpi=300&quality=.5 Accept: image/jpeg

Add a signature field to the PDF PUT http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields/myfield (sample JSON in message body) { “widget”:[ { “pageIndex”:0, “rectangle”: { “x”:100, “y”:100, “width”:200, “height”:50 } } ] } Get all signature fields the PDF GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields Sign the PDF POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields/myfield/signature (pfx or p12 file as attachment) (sample JSON) { “keystorePassword”:”password”, “keyAlias”:”alias”, “keyPassword”:”password”, “certifyingSignature”:true, “certifyingPermissions”:3, […]

Get the current permissions GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/permissions Clear the usage rights DELETE http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/permissions/usage-rights Clear the password permissions DELETE http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/permissions/password-permissions Set password permissions PUT http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/permissions/password-permissions (sample JSON in message body) { “encryptType”:1, “openPassword”:”openPass”, “permissionsPassword”:”permsPass”, “changeDocumentAllowed”:false, “assembleDocumentAllowed”:false }

Stamp the document with text POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/pages (sample JSON) { “TextStampAction”:{ “rotation”:15, “transparency”:50, “x”:100, “y”:100, “text”:”HelloWorld”, “color”:0, “fontSize”: 32, “fontName”: “Courier”, “fontStyle”: “Plain”, “pageIndex”:1 } } } Stamp the document with an image POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/pages (image file as attachment) (sample JSON) { “ImageStampAction”:{ “rotation”:15, “x”:100, “y”:100, “pageIndex”:1 } }

OCR a PDF POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/pages (sample JSON) { “OCRAction”: { “language”:”eng”, “dpi”:300 } } Extract the text from a PDF GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/pages/0/text

Linearize a PDF POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf (sample JSON in message body) { “LinearizeAction”: { “savePath”: “linearized/mydoc.pdf” } }

Create a new optimization profile PUT http://{host}:{port}/qoppapdf/v1/optimize-profiles/myprofile (sample JSON in message body) { “discardAnnotations” : true, “discardUnusedResources” : true, “mergeDuplicateFonts” : true, “mergeDuplicateImages” : true, “compressObjectsIntoStreams” : true, “colorImageHandler”: { “colorSpace”: 1, “compression”: 1, “dpi”: 150, “jpegQuality”: 0.8 }, “grayImageHandler”: { “colorSpace”: 1, “compression”: 1, “dpi”: 150, “jpegQuality”: 0.7 }, “bwImageHandler”: { “colorSpace”: 2, “compression”: […]

Append two PDFs that are both already uploaded POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/pages { “InsertUploadedPagesAction”: { “appendFilePath”:”mydir/subdir/myotherdoc.pdf”, “appendPassword”:”password”, “pageRange”:1 } } Upload and append a PDF to an existing PDF POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/pages (PDF file as attachment) (sample JSON) { “InsertAttachedPagesAction”: { “pageIndex”:2, “pageRange”:”2-4″ } } Append an image to an existing PDF POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/pages (image file attached) (sample […]

Create a new folder PUT http://{host}:{port}/qoppapdf/v1/documents/mydir Upload a PDF via PUT PUT http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf Content-Type: application/pdf (PDF file in message body) Upload a PDF via POST POST http://{host}:{port}/qoppapdf/v1/documents/mydir?namingMode=1 (file as attachment) Upload an image as a PDF PUT http://{host}:{port}/qoppapdf/v1/documents/mydir/jpeg.pdf Content-Type: image/jpeg (image file in message body) Upload a Word document as a PDF PUT http://{host}:{port}/qoppapdf/v1/documents/mydir/word.pdf Content-Type: […]