n8n-nodes-json2doc

This is an n8n community node for Json2Doc - a powerful JSON to Document Generation Platform. It provides nodes to interact with Json2Doc's API for file management, template handling, and document generation jobs.

Installation

Community Nodes (Recommended)

1. Go to Settings > Community Nodes in n8n
2. Click Install
3. Enter n8n-nodes-json2doc
4. Agree to the risks of installing a community node
5. Click Install

Manual Installation

To use this node locally or for development:

# In your n8n root folder
cd ~/.n8n
npm install n8n-nodes-json2doc

Restart n8n to load the node.

Features

This package provides three main nodes:

Json2Doc Files

Manage files in Json2Doc:

• Upload - Upload images or fonts for use in documents
• Download - Download files by ID
• Generate Public Link - Create time-limited public download links

Json2Doc Templates

Manage document templates:

• Upload - Upload DOCX templates
• List - List all your templates
• Get - Get template details
• Download - Download template files

Json2Doc Jobs

Create and manage document generation jobs:

• Create Document - Generate documents from JSON configuration
• Fill Template - Fill templates with variables
• List - List all jobs with filtering options
• Get - Get job details and status
• Validate - Validate job configurations before submission

Credentials

To use these nodes, you need a Json2Doc API key:

1. Sign up at json2doc.com
2. Get your API key from your dashboard
3. In n8n, go to Credentials and create a new Json2Doc API credential
4. Enter your API key

The credential also allows you to specify a custom base URL if you're using a self-hosted instance.

Usage Examples

Example 1: Generate a PDF from JSON

1. Add a Json2Doc Jobs node
2. Select Create Document operation
3. Add your document configuration in JSON format
4. Execute the workflow
5. The node returns the job ID and status

Example 2: Fill a Template

1. Upload a DOCX template using Json2Doc Templates node (Upload operation)
2. Add a Json2Doc Jobs node
3. Select Fill Template operation
4. Enter the template ID and variables as JSON
5. Execute to generate the document

Example 3: Monitor Job Status

1. Create a document job
2. Add another Json2Doc Jobs node
3. Select Get operation
4. Use the job ID from the previous node
5. Check the status and download when completed

Development

Want to contribute or customize this node? Here's how to set up your development environment:

Prerequisites

• Node.js v22 or higher
• npm

Setup

# Clone the repository
git clone https://github.com/centerbitco/n8n-nodes-json2doc.git
cd n8n-nodes-json2doc

# Install dependencies
npm install

# Start development server
npm run dev

This starts n8n with your nodes loaded and hot reload enabled.

Build

npm run build

Lint

npm run lint
npm run lint:fix

API Documentation

For detailed information about the Json2Doc API, including:

• Complete configuration schemas
• Available document types and formats
• Template variable syntax
• Job status codes and error handling

Visit the official documentation at json2doc.com/docs.

Compatibility

• n8n version: 0.180.0 or higher
• Node.js: v22 or higher

Support

• For issues with this n8n node: Open an issue
• For Json2Doc API questions: Visit json2doc.com/docs or contact [email protected]
• For n8n questions: Visit the n8n community forum

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

MIT

Links

• Json2Doc Website
• Json2Doc API Documentation
• n8n Website
• n8n Community Nodes