General Guidelines - Complete Documentation Overview
Welcome to the PDF4me General Guidelines documentation—your comprehensive resource for mastering document automation, API integration, and template-based document generation. This section provides essential knowledge and step-by-step instructions to help you leverage PDF4me's powerful document processing capabilities across various automation platforms and integration methods.
Whether you're a developer building custom integrations, a business user automating document workflows, or a technical professional implementing document generation systems, these guidelines will help you achieve efficient, scalable document automation solutions.
Documentation Structure
The General Guidelines documentation is organized into four main sections, each designed to help you accomplish specific document automation goals:
- Getting Started
- Word Template Syntax
- Document Parsing
- Document Generation
Begin your PDF4me journey with essential setup and connection guides covering API Portal registration and platform connections.
| Guide | Description | Link |
|---|---|---|
| API Portal Registration | Create account, activate free trials, obtain API keys, manage subscriptions | Getting Started with API Portal |
| Connect to V2 API | Direct REST API integration with authentication and endpoint documentation | Connect to PDF4me API |
| Connect to Power Automate | Microsoft workflow automation with OAuth and API key authentication | Connect to Power Automate |
| Connect to Zapier | Multi-app automation platform with hundreds of integrations | Connect to Zapier |
| Connect to Make | Visual automation platform for complex workflow scenarios | Connect to Make |
| Connect to n8n | Open-source workflow automation with extensive customization | Connect to n8n |
Each connection guide includes step-by-step authentication instructions, prerequisite requirements, practical examples, and troubleshooting guidance for common issues.
Master dynamic document generation using PDF4me's powerful Word template engine to create professional, data-driven documents.
| Topic | Description | Link |
|---|---|---|
| Syntax Overview | Fundamental merge field syntax and template structure | Syntax Overview |
| Variables | Custom variables, calculations, and dynamic value management | Variables in Templates |
| Formatting | String transformations, date formatting, and number formatting | Formatting in Templates |
| Repeat Sections | Foreach loops for generating multiple paragraphs and sections | Repeat Paragraphs and Sections |
| Tables | Dynamic table generation with repeating rows and calculations | Tables in Templates |
| Lists | Bullet and numbered list generation from data collections | Lists in Templates |
| Text Controls | Conditional logic and text manipulation in templates | Text Controls |
| Images | Insert and manipulate images dynamically in documents | Insert Images |
| Hyperlinks | Create dynamic hyperlinks in generated documents | Hyperlinks in Templates |
| HTML Insertion | Embed HTML content in Word templates | Insert HTML |
| Document Insertion | Insert complete documents into templates | Inserting Documents |
| Enumeration | Advanced enumeration methods and expressions | Enumeration in Templates |
- Merge fields:
<<[FieldName]>> - Variables:
<<var [name = value]>> - Conditionals:
<<if [condition]>>...<<else>>...<</if>> - Loops:
<<foreach [item in collection]>>...<</foreach>> - Formatting:
<<[field]:"format">>
Extract structured data from PDF documents using template-based capture areas and regular expressions.
- Template-based parsing for consistent data extraction
- Visual capture area selection for precise field mapping
- Regular expression support for pattern matching
- Test and validation tools for parsing accuracy
Documentation: Prepare Parse Info for a Document
Use Cases: Invoice data extraction, form field value extraction, document classification, structured data capture from PDFs
Generate professional documents from templates using various automation platforms.
| Platform | Template Types | Documentation |
|---|---|---|
| Make | Word, HTML | Generate from Word Template, Generate from HTML Template |
| Power Automate | Word, HTML | Generate Document with Power Automate, Generate from Word Template |
| Zapier | Word, HTML | Generate from Word Template, Generate from HTML Template |
Data Formats: JSON (recommended), XML, CSV
Output Formats: PDF, Word (DOCX), HTML
Quick Start Guide
New to PDF4me? Follow this quick start path to get up and running:
- API Integration
- Automation Platforms
- Document Generation
For Developers and Custom Integrations
Step 1: Register for API Portal - Create account at dev.pdf4me.com, activate free trial, obtain API key
Step 2: Connect to V2 API - Learn authentication, endpoints, response codes, and error handling
Step 3: Explore API Documentation - Review endpoint references, test with API Tester, check Code Samples in C#, Java, Python, JavaScript, Salesforce Apex
All code samples are available in the GitHub Repository with ready-to-use examples for all features.
For Business Users and Workflow Automation
Step 1: Get Your API Key - Register at dev.pdf4me.com, access dashboard, understand subscription plans
Step 2: Choose Your Platform
- Power Automate - Connect Guide | Integration Docs
- Zapier - Connect Guide | Integration Docs
- Make - Connect Guide | Integration Docs
- n8n - Connect Guide | Integration Docs
Step 3: Build your first workflow - Start with document conversion, progress to template generation, explore barcode operations and data extraction
Choose based on your needs: Power Automate for Microsoft 365, Zapier for multi-app automation, Make for visual workflows, n8n for open-source customization.
For Template-Based Document Creation
Step 1: Learn Template Syntax - Merge fields <<[FieldName]>>, basic structure, examples
Step 2: Master Variables - Custom variables <<var [name = value]>>, calculations, scope
Step 3: Apply Formatting - Dates <<[date]:"dd.MM.yyyy">>, text <<[text]:upper>>, numbers
Step 4: Build Tables - Dynamic tables, calculations, totals, single/multi-column structures
Step 5: Generate Documents - Use templates in workflows, generate from Word templates with JSON data
Plan structure before adding merge fields, use descriptive field names, test with sample data, apply formatting in templates for consistent output.
Key Capabilities Overview
- Document Conversion
- Document Generation
- Data Extraction
- Platform Integration
Transform files between various formats with professional quality and formatting preservation.
| Conversion Type | Supported Formats | Documentation |
|---|---|---|
| To PDF | Word, Excel, PowerPoint, HTML, Markdown, Images, Visio | Convert to PDF |
| From PDF | Word, Excel, PowerPoint, Images | PDF Conversions |
| Image Formats | JPEG, PNG, GIF, BMP, TIFF, WebP | Image Operations |
| Special Formats | PDF/A, Flatten PDF, Linearize PDF | PDF Utilities |
All conversions maintain professional quality and formatting preservation, ensuring your documents look exactly as intended.
Create personalized documents from Word or HTML templates using JSON, XML, or CSV data sources.
Template Features:
- Dynamic Variables -
<<[FieldName]>>merge field syntax - Conditional Logic -
<<if [condition]>>conditional statements - Repeating Sections -
<<foreach [item in collection]>>loops - Formatting Control - Date, number, and text transformations
- Complex Structures - Nested loops, multi-level tables, hierarchical content
Related Documentation:
- Word Template Syntax Overview
- Generate Document with Zapier
- Generate Document with Power Automate
- Generate Document with Make
JSON is recommended for best compatibility, but XML and CSV formats are also supported for document generation.
Parse PDF documents to extract structured data using template-based capture areas and regular expressions.
Extraction Capabilities:
- Template-based parsing for consistent data extraction
- Visual capture area selection for precise field mapping
- Regular expression support for pattern matching
- Test and validation tools for parsing accuracy
Use Cases: Invoice processing, form field value extraction, document classification, structured data capture
Related Documentation:
Always test and validate parsing templates with sample documents to ensure accurate data extraction before production use.
Connect PDF4me with leading automation platforms to build end-to-end document workflows without writing code.
| Platform | Authentication | Key Features | Documentation |
|---|---|---|---|
| Power Automate | OAuth, API Key | Microsoft 365 integration, two connector options | Connect Guide |
| Zapier | API Key | 1000+ app integrations, easy workflow building | Connect Guide |
| Make | API Key | Visual workflow design, complex scenarios | Connect Guide |
| n8n | API Key | Open-source, self-hosted option, extensive customization | Connect Guide |
| REST API V2 | API Key | Direct integration, full control, custom applications | API Guide |
Choose Power Automate for Microsoft 365 users, Zapier for multi-app automation, Make for visual workflows, n8n for open-source flexibility, or REST API for custom integrations.
Common Use Cases
- Invoice Processing
- Contract Management
- Report Generation
- Document Archiving
- Form Processing
Generate invoices from templates with dynamic line items using Word templates, merge fields, dynamic tables, and formatting. Generate PDF invoices automatically from JSON data.
Extract invoice data from PDF documents using document parsing, capture areas, and structured data extraction.
Automate delivery - Convert to PDF, add barcodes for tracking, compress for storage, integrate with email and cloud storage.
Related Resources:
Combine template generation with parsing to create a complete invoice processing workflow—generate invoices and extract data from received invoices automatically.
Create contracts from templates with personalized terms using Word templates with conditional sections, dynamic clauses, and personalized generation.
Add security - Password protection, digital signatures, encryption for secure contract management.
Parse contract data - Extract key terms and dates using document parsing, classify by type and status, store in databases.
Related Resources:
Always use password protection and digital signatures for sensitive contracts. Store API keys securely and never commit them to public repositories.
Generate monthly reports with dynamic data tables, header/footer sections, tables from collections, and calculated metrics using variables.
Executive summaries - Use variables for calculations, format numbers and percentages, display conditional content based on thresholds.
Professional styling - Consistent formatting, date formatting for periods, charts and visual elements.
Related Resources:
Pre-calculate complex values in your data source and use variables to avoid repeating calculations for better performance.
Convert emails and attachments to PDF format, process multiple attachments in batch, maintain email formatting.
Organize documents - Add barcodes for tracking, split PDFs by barcode, read barcodes for routing.
Compress and optimize - Reduce file sizes while maintaining quality, optimize PDFs for web viewing, optimize images and resources.
Related Resources:
Use compression and optimization features to reduce storage costs while maintaining document quality and accessibility.
Fill PDF forms automatically from data sources - Map data fields, populate with JSON/XML data using Fill PDF Form API, generate filled forms in batch.
Extract form data - Extract form field values and properties, parse into structured formats, integrate with database systems.
Generate forms - Create interactive PDF forms from Word documents, design form templates with merge fields, generate personalized forms automatically.
Related Resources:
Combine form filling with data extraction to create complete form processing workflows—fill forms from databases and extract data from completed forms.
Best Practices
- Template Design
- API Integration
- Automation Workflows
- Performance Optimization
Planning: Plan structure before adding merge fields, use descriptive consistent field names, organize logically, maintain template versions.
Testing: Test with sample data before production, verify formatting with actual scenarios, test edge cases (empty collections, null values), validate output quality.
Formatting: Apply formatting in templates for consistent output, use template formatting rather than post-processing, maintain consistent date/number formats, consider locale-specific requirements.
Related Documentation:
Always test templates with sample data that includes edge cases such as null values, very long strings, or dates in different formats to ensure consistent output.
Security: Store API keys securely (never commit to public repositories), use environment variables or secure key management, rotate keys periodically, implement proper authentication error handling.
Monitoring: Monitor API call usage through dashboard, set up alerts for usage thresholds, track API performance and response times, review API logs for troubleshooting.
Error Handling: Implement comprehensive error handling, use appropriate HTTP status codes, handle rate limiting and retry logic, provide meaningful error messages.
Related Documentation:
Your API key is sensitive information. Store it securely and never share it publicly or commit it to public repositories. Learn more about API authentication.
Workflow Design: Start simple and gradually add complexity, document workflows for team collaboration, use clear naming conventions, organize by function or department.
Testing: Test each step individually before building complete workflows, use test data to validate logic, test error scenarios and edge cases, validate output quality at each step.
Error Handling: Use conditional logic for edge cases, implement error notifications and alerts, create fallback paths for failed operations, log workflow execution for debugging.
Related Documentation:
Start with simple document conversion workflows and gradually progress to more complex scenarios like document generation from templates and advanced features like barcode operations.
Data Processing: Pre-filter large collections before template processing, limit nested loops to 2-3 levels, pre-calculate complex values in data source, use efficient data structures.
File Management: Use appropriate file formats and compression settings, optimize images before including in documents, consider file size limits for API requests, use async processing for large documents.
Template Optimization: Minimize complex calculations in templates, use variables to avoid repeating calculations, simplify template structure when possible, cache frequently used templates.
Related Documentation:
Pre-filter large data collections before template processing and limit nested loops to 2-3 levels for better performance. Consider pre-calculating complex values in your data source.
Next Steps
Ready to dive deeper? Explore these sections based on your needs:
- For API Developers
- For Automation Users
- For Template Designers
- For Data Extraction
Getting Started:
- API Portal Registration - Create account and get API key
- Connect to V2 API - Learn authentication and endpoints
- API Documentation - Complete endpoint references
- API Tester - Test endpoints interactively
Advanced Topics:
- Code Samples - Examples in C#, Java, Python, JavaScript
- API Response Codes - Error handling
- Troubleshooting - Common errors and how to fix them
- Authentication Guide - Security best practices
Browse the GitHub Repository for ready-to-use code examples in C#, Java, Python, JavaScript, and Salesforce Apex.
Platform Selection:
- Power Automate - Microsoft 365 integration
- Zapier - Multi-app automation
- Make - Visual workflows
- n8n - Open-source option
Integration Resources:
- Power Automate Integration - Complete guide
- Zapier Integration - Action documentation
- Make Integration - Scenario examples
- n8n Integration - Workflow templates
Each platform offers comprehensive PDF4me actions covering conversion, editing, extraction, security, and optimization. Choose based on your existing infrastructure and workflow needs.
Fundamentals:
- Template Syntax Overview - Basic syntax
- Variables in Templates - Dynamic values
- Formatting in Templates - Data formatting
Advanced Features:
- Tables in Templates - Dynamic tables
- Repeat Paragraphs and Sections - Loops
- Text Controls - Conditional logic
- Insert Images - Image handling
Document Generation:
Start with basic merge field syntax, then progress to variables and formatting, followed by advanced features like tables and loops. Test each concept with sample data before building complex templates.
Document Parsing:
- Prepare Parse Info for a Document - Setup guide
- Configure capture areas and regular expressions
- Test and validate parsing templates
Related APIs:
- Parse Document API - API documentation
- Extract Text by Expression - Pattern matching
- Extract Form Data - Form extraction
- Classify Document - Document classification
Always test and validate parsing templates with sample documents to ensure accurate data extraction. Use the test parse feature in the dashboard before production use.
Bookmark this page and refer back to it as you progress through the documentation. The General Guidelines are designed to work together—understanding the connections between API integration, template syntax, and automation platforms will help you build more sophisticated document automation solutions.
This documentation is regularly updated to reflect new features, platform changes, and best practices. Check back periodically for the latest information and improvements.
Getting Help
Need assistance? PDF4me provides comprehensive support resources:
Quick Links: API Documentation | Troubleshooting | Integration Guides | API Tester | Code Samples | GitHub Repository | Dashboard
Our team is here to support you throughout your PDF4me journey. Reach out through the support portal or check our comprehensive documentation for guidance.