PDF Generator API icon

PDF Generator API

Generate PDFs, manage templates, convert HTML/URLs to PDF, and perform PDF operations like watermarking, encryption, and optimization

Actions28

Overview

The node integrates with a PDF Generator API to manage PDF templates and perform various operations related to PDF document generation and editing. Specifically, for the Template - Open Editor operation, it retrieves a URL or session information to open an online editor interface for a selected PDF template. This allows users to preview and edit templates interactively, optionally providing data for preview and selecting the editor's UI language.

This node is beneficial in scenarios where users need to customize PDF templates dynamically before generating documents, such as updating branding, adjusting layouts, or previewing how data merges into templates. For example, a marketing team could use this to quickly modify invoice templates or promotional materials without leaving their workflow automation environment.

Properties

Name Meaning
Template Select the template to work with. Can be chosen from a searchable list or entered by ID (number).
Editor Options Collection of options to configure the editor:
  Data JSON object used to preview the template in the editor (e.g., sample data to merge).
  Language Language of the editor UI. Options: Czech, English, Estonian, German, Russian, Slovak. Default is English.

Output

The output JSON contains the response from the API call that opens the template editor. Typically, this includes a URL or session token allowing access to the online template editor interface. The exact structure depends on the API but generally provides:

  • A success indicator.
  • An editor URL or session details to launch the editor.
  • Possibly metadata about the template or preview data used.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for the PDF Generator API service.
  • The node makes authenticated HTTP POST requests to the endpoint /templates/{templateId}/editor on the configured API base URL.
  • The user must have appropriate permissions to access and edit the specified template via the API.

Troubleshooting

  • Invalid Template ID: If the template ID is missing, invalid, or not numeric when entered manually, the node will throw an error. Ensure the template ID is correct and numeric.
  • Malformed JSON in Data: The data field in editor options must be valid JSON. Invalid JSON will cause a parsing error.
  • API Authentication Errors: Missing or incorrect API credentials will result in authentication failures. Verify the API key configuration.
  • Permission Denied: If the API user lacks permission to open the editor for the selected template, the API will return an error.
  • Network Issues: Connectivity problems to the API endpoint can cause request failures.

To resolve errors:

  • Validate all input parameters carefully.
  • Check API credentials and permissions.
  • Confirm network connectivity.
  • Use valid JSON syntax for the preview data.

Links and References

Discussion