Skip to main content

Quick Start with Postman

Tools like Postman simplify testing and interaction with the PDFBolt API, making it easy to explore its features without writing any code.

1️⃣ Get Your API Key​

  • Your API Key can be found in the Admin Dashboard or in the welcome email you received after signing up.
  • The API Key is required to authenticate your requests to the PDFBolt API.

2️⃣ Set Up Postman for PDFBolt​

1. Create a New Request:​

  • Open Postman and create a new Request.
  • Set the HTTP Method to POST.
  • Enter one of the following PDFBolt API endpoint URLs based on your use case:
https://api.pdfbolt.com/v1/direct
https://api.pdfbolt.com/v1/sync
https://api.pdfbolt.com/v1/async

2. Set Up Authentication:​

  • Go to the Authorization tab.
  • Choose API Key as the Auth Type.
  • Enter the following values:
    • Key: API_KEY
    • Value: Your unique API key.
    • Select Header to include the key in the request headers.

3. Define the Request Body:​

  • Navigate to the Body tab.
  • Select raw and set the content type to JSON.
  • Use the following example request body to generate a PDF:
{
  "url": "https://example.com/",
  "printBackground": true,
  "format": "A4",
  "landscape": true,
  "margin": {
    "top": "10px",
    "right": "20px",
    "left": "20px",
    "bottom": "10px"
  },
  "timeout": 60000
}
note

If you want to use the /async endpoint, ensure you include the webhook parameter in your request.

4. Send the Request:​

  • Click Send to execute the request.
  • Upon success, the response will contain either a raw PDF or a download URL, depending on the endpoint used.

3️⃣ What’s next?​

Test API Endpoints and experiment with Conversion Parameters directly in Postman. Modify the request body to include additional parameters to customize your document generation process.


Why Use Postman or a Similar Tool?

Here’s why they’re a great choice:

  • Quick Testing: Easily prototype and test your requests without hassle.
  • Code-Free Interaction: Generate PDFs and interact with the API without writing code.
  • Easy Configuration: Configure endpoints, parameters, and authentication effortlessly.
  • Debugging Support: Inspect requests and responses for effective troubleshooting and optimization.