Getting started with Qoppa PDF REST API on Postman

Here is a Postman file containing sample REST calls to Qoppa PDF REST API to create, convert and manipulate PDF documents. This is a good way to get started with our REST API. After installing Qoppa PDF Automation Server (PAS) on your own server, just import this file into Postman, set up the parameter options […]

Read More

Curl request to insert a new page into a PDF

You can use Curl to send requests to QOPPA PDF REST API. Here’s a sample curl request for adding a new page to an existing PDF (in this case the document is “alphabets.pdf” and is present at the root of the server: curl -X POST http://host:port/qoppapdf/v1/documents/alphabets.pdf/pages -H “Content-Type:multipart/form-data” -F “pageAction={\”NewPageAction\”: {}};type=application/json”

Read More

Getting started with Qoppa PDF REST API on JMeter

Here is a JMeter file containing sample REST calls to Qoppa PDF REST API to create, convert and manipulate PDF documents. This is a good way to get started with our REST API. After installing Qoppa PDF Automation Server (PAS) on your own server, just import this file into jMeter, set up the parameter options […]

Read More

Difference between REST API and Workflow Modules in PAS

Q: What is the difference between the REST API Module in PDF Automation Server and the Workflow Module? PDF Automation Server (PAS) REST API and Workflow modules can both be used to automate PDF document processes on the server side, each in their own different way. Customers can choose between these two modules the better […]

Read More

Rest API PDF/A PDF/X Conversion and Verification

Convert a PDF to PDF/A (Profiles supported: pdfa1b, pdfa2b, pdfa3b) POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf (sample JSON in message body) { “PDFAConvertAction”:{ “profile”: “pdfa1b”, “unsupportedAnnots”: 1, “embeddedFiles”: 1, “transparency”: 1, “appendReport”: true, “addAnnots”: true, “savePath”: “mydoc_converted.pdf” } } PDF/A Verification (Profiles supported: pdfa1b, pdfa2b, pdfa3b, pdfa1a, pdfa2u, pdfx1a2001, pdfx1a2003, pdfx32002, pdfx32003) GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/preflight-results?profile=pdfa1b

Read More

Troubleshooting PAS REST Server Connection Issues

Q: When I try to connect to the PDF Automation Server Rest Module I get an error saying “This site cannot be reached”. How can I fix this? A: Follow the troubleshooting steps below to get connected to your server Make sure the PAS service is running First check to make sure that the server […]

Read More

PDF Automation Server now available on Amazon AWS marketplace

Qoppa’s PDF Automation Server is now available on the Amazon AWS marketplace making it easy for companies to automate their document workflows in the cloud! The powerful server can be up and running in just a few clicks, letting users define their own workflow jobs and making calls to upload and process documents through REST calls. Download […]

Read More

Rest API Import Export Flatten Annotations from PDF Documents

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” } }

Read More

Rest API Export Merge Flatten Form Fields in a PDF Document

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” } }

Read More

Rest API Sign PDF Documents

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, […]

Read More

Rest API Encrypt and Set Permissions, Passwords on PDF documents

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 }

Read More

Rest API Add Watermarks Headers Footers to PDF Documents

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 } }

Read More

Rest API OCR PDF Documents

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

Read More

Rest API Linearize PDF Documents

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

Read More

Rest API Optimize 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”: […]

Read More

Rest API PDF Document Assembly

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 […]

Read More

Rest API Create and Upload PDF / Image or Word Doc

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: […]

Read More

REST API for PDF Processing

Interested in easily deploying PDF processes in the cloud or running PDF services? Qoppa Software’s new REST API is done just for that and allows customers to create, edit and serve PDF documents through simple REST calls. Qoppa Software REST API is comprehensive, flexible interface to our existing powerful Java API. What is REST? REST […]

Read More