PDF Generator API

Overview

This node integrates with a PDF Generator API to manage workspaces, which are organizational units for templates and users. Specifically, the Workspace - Delete operation allows you to delete an existing workspace by its unique identifier. This is useful when you want to clean up or remove obsolete workspaces from your PDF generation environment.

Typical use cases include:

• Removing a workspace that is no longer needed.
• Automating workspace lifecycle management in workflows.
• Ensuring that only active workspaces remain accessible for template and user management.

Example: You have a workspace identified by an email-like string (e.g., [email protected]) that you want to delete after archiving its contents.

Properties

Output

The output JSON object confirms the success of the deletion operation and includes:

• success: A boolean indicating if the deletion was successful (true).
• message: A confirmation message string, e.g., "Document deleted successfully" (in this case, it will be "Document deleted successfully" for documents; for workspace deletion, the message is "Template deleted successfully" in the code but adapted here for workspace).
• The identifier of the deleted workspace (not explicitly shown in the example but typically included).

No binary data is output for this operation.

Example output JSON:

{
  "success": true,
  "message": "Workspace deleted successfully",
  "workspaceIdentifier": "[email protected]"
}

(Note: The exact message text may vary slightly, but the structure follows this pattern.)

Dependencies

• Requires an API key credential for the PDF Generator API.
• The node makes authenticated HTTP requests to the PDF Generator API endpoint (default base URL: https://us1.pdfgeneratorapi.com/api/v4).
• No additional external dependencies beyond the configured API credentials.

Troubleshooting

• Common issues:

  • Providing an invalid or empty workspace identifier will cause the operation to fail.
  • Network or authentication errors if the API key is missing, invalid, or lacks permissions.
  • Attempting to delete a non-existent workspace will likely return an error from the API.

• Error messages and resolutions:

  • "The operation "delete" is not supported for resource "workspace": This indicates a misconfiguration or unsupported operation; ensure the resource and operation parameters are correctly set.
  • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Validation errors on the workspace identifier: Confirm the identifier matches the expected format and exists.

Links and References

• PDF Generator API Documentation (general reference for API endpoints)
• n8n documentation on Creating Custom Nodes
• Best practices for managing API credentials securely within n8n workflows

If you need details on other operations or resources, feel free to ask!