datalogics / pdf-rest-api-samples

pdfRest API Toolkit is a REST API service for processing PDF documents, made by developers, for developers. Rapidly integrate PDF workflows with your existing projects and applications, simply and seamlessly. Get started for free in seconds.

pdfRest.com |  Get Started  |  API Lab |  Explore the Toolkit  |  Solutions  |  Pricing  |  Documentation  |  Support

pdfRest API Toolkit

pdfRest is a REST API Toolkit for developers with all of the API Tools you'll need to power your PDF processing requirements, designed and documented by PDF experts to make your development work easier than ever. Rapidly integrate PDF capabilities into web applications in minutes, not days.

Compress PDF	Convert to PDF	Convert to PDF/A	Convert to PDF/X
Encrypt PDF	Restrict PDF	Merge PDFs	Split PDF
Decrypt PDF	Unrestrict PDF	Add to PDF	PDF to Images
Watermark PDF	Flatten Transparencies	Flatten Annotations	Flatten Layers
Query PDF	Linearize PDF	Upload Files	Zip Files
Flatten Forms	Import Form Data	Export Form Data	Extract Text
PDF to Word	PDF to Excel	PDF to PowerPoint

Get started quickly with our API Lab web app, trust in high quality Adobe® technology, and keep costs to a minimum with the best fit plan for every business application (including a generous free plan).

Getting Started with Code Samples

This GitHub repository provides public access to code examples that demonstrate how to programmatically submit requests to the pdfRest API Toolkit service.

Start by generating a free API Key, required to run these samples. Choose between a Guest API Key for 50 free API Calls before signing up, or create an account with a Starter plan for 300 free API Calls per month. Plans scale up from there to support all projects and applications, big and small.

Instructions for Running Code Samples

Uploading an input file

POST requests require an API Key. To apply your API Key, you must include it in your requests as a header called Api-Key.

Before running each sample program, look for a comment that reads:

Place your api key here

and replace xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx with your API Key.

Downloading your output file(s)

Each subdirectory includes a get-resource sample that demonstrates how to download output files.

When you make a POST call to one of the API endpoints, you will receive back a response that includes an ID reference to each resource, including newly uploaded input files and newly generated output files. These IDs are in the form of a universally unique identifier (UUID).

Before running this sample program, look for a comment that reads:

place resource uuid here

and replace xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx with the resource UUID you received back from a previous POST request. You may also wish to update the variable containing the output file name before sending your GET request.

Running a sample program

Below are instructions for running a sample in each language included in this repository.

API Documentation

After you've successfully sent an API Call using these examples, take a look at the Documentation for each API endpoint for a full description of parameters you can adjust to customize your solution.

Postman Collection

Use Postman to fast-track your API testing! Check out the pdfRest Postman Collection to start sending POST requests with just a few clicks from pre-configured POST requests.

Support

If you have any trouble getting started, please reach out to us through our Support form, and a member of the pdfRest team will be in touch as soon as possible.