Skip to main content

Introduction

Welcome to the reportgen Engine API documentation. This API is designed to help developers generate customizable PDF reports efficiently. Whether you are building dynamic documents, automated reports, or templated invoices, the reportgen API allows you to manage the process seamlessly.

Key Features​

  • PDF Generation: Start asynchronous or synchronous PDF generation using popular templating engines like EJS, Handlebars, and GoTempl, or just transform raw HTML directly to PDF without any templating using the Raw option.
  • Custom Data: Insert your own data into predefined or custom templates.
  • Access Control: Use secure access keys to manage and authenticate your API requests.

Getting Started​

To begin using the API, visit our Getting Started page, where you'll find step-by-step instructions on setting up your access keys, configuring your API requests, and generating your first PDF report.

API Structure​

The API is organized into multiple endpoints that handle various actions such as:

  • PDF Generation: Create and download reports using your data and templates or raw HTML directly converted to PDF.
  • Reports Management: Retrieve, delete, and manage your generated reports.
  • Access Keys: Securely generate, list, and delete access keys for API authentication.

For full details of available endpoints, refer to the API Reference page where you can find the automatically generated API reference.

Explore Use Cases​

To learn more about how you can use the API in different scenarios, check out the Examples section, which covers specific use cases like generating invoices and reports.

Support​

If you need assistance or have any questions, feel free to reach out via our contact form.