Skip to content

Latest commit

 

History

History
95 lines (52 loc) · 5.3 KB

README.md

File metadata and controls

95 lines (52 loc) · 5.3 KB
Raw

pdfRest

pdfRest.com |  Get Started  |  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 Merge PDFs Split PDF
Encrypt PDF Restrict PDF PDF to Images Convert to PDF/A
Decrypt PDF Unrestrict PDF Add to PDF Query PDF
Watermark PDF Flatten Transparencies Linearize PDF Zip Files

Get started quickly with our "1 Minute to REST, Easy" guarantee, 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-id-endpoint 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.

How to run JavaScript samples

Using Node 16 or greater:

  1. cd Node/
  2. npm install node-fetch
  3. node name-of-sample-program.js

How to run PHP samples

  1. cd PHP/
  2. php name-of-sample-program.php

How to run Python samples

Using Python3:

  1. cd Python/
  2. python name-of-sample-program.py

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.