Postman Collection

Postman is a cross-platform graphical user interface application for interacting with APIs. You can use our official Postman collection to get started with PSPDFKit API with a click of a button. We include example files with the collection so that you can try different examples right away.

Getting Started

  1. 1
    Download the collection here.
  2. 2
    Unzip the downloaded archive.
  3. 3
    Download and install Postman if you don’t have it on your computer yet. You can also use it directly in the browser, but please note that you’ll need to manually add the example files to all the examples.
  4. 4
    Add the collection to Postman by importing the pspdfkit-api.postman_collection.json file from the unzipped archive. Follow the official Postman guide on importing collections.
  5. 5
    Move the example files to your Postman working directory. To do that, find the working directory location in settings, and move the pspdfkit-api folder from the unzipped archive to that location.
  6. 6
    Configure your API key. Go to the API Keys page in the dashboard and copy the key. Now, configure the key in the collection’s authorization settings. The screenshot below shows where to paste the API key.

Screen capture of the Postman window with the Authorization section open. An arrow points to the text field where the API key should be added.

Using the Examples

Now that you’ve set up the collection, you can start calling the API from Postman. Pick any example request in the left sidebar and click Send to send a request. You should see the preview of the result at the bottom of the window.

Screen capture of the Postman window with the HTML to PDF example open and a preview of the result at the bottom.

You can also save the result on your computer by clicking the Save Response button.