📄 Keener Exporter API

Microserviço de Geração de PDFs

v1.0.0

🔐 Token de Autenticação

Configure seu token de autenticação para testar os endpoints. O token será incluído automaticamente no header Authorization de todas as requisições.

⚠️ Nenhum token configurado

🚀 Quick Start

  1. Envie seu template HTML + dados via multipart/form-data
  2. Receba o PDF em base64

💡 Dica: Baixe templates para testar: 📥 Template EJS 📥 Template HTML

Base URL

http://localhost:3333/api/exporter

Status

🟢 Online
POST /generate/ejs Síncrono

Gerar PDF de Template EJS

Gera um PDF imediatamente a partir de um template EJS com dados dinâmicos. Ideal para documentos que precisam de variáveis e lógica.

ℹ️ Quando usar: Documentos com dados dinâmicos, variáveis EJS, baixo volume (< 10 req/min).

Parâmetros (multipart/form-data)

Campo Tipo Obrigatório Descrição
file File (.ejs) ✅ Sim Arquivo EJS do template
data JSON String ❌ Não Dados para renderizar no template EJS
options JSON String ❌ Não Opções do PDF (formato, margens, etc)
curl -X POST http://localhost:3333/api/exporter/generate/ejs \
  -F "file=@template.ejs" \
  -F 'data={"title":"Relatório","date":"2024-01-01","items":[]}' \
  -F 'options={"format":"A4","margin":{"top":"10mm"}}'

Resposta (200 OK)

{
  "message": "PDF generated successfully from EJS template.",
  "pdf": "data:application/pdf;base64,JVBERi0xLjQKJ..."
}

🧪 Testar Endpoint

Selecione um arquivo .ejs para usar como template
Dados para renderizar no template EJS (opcional)
Opções de formatação do PDF (opcional)
POST /generate/html Síncrono

Gerar PDF de Arquivo HTML

Gera um PDF imediatamente a partir de um arquivo HTML puro. Não processa variáveis dinâmicas.

ℹ️ Quando usar: HTML estático, sem necessidade de dados dinâmicos, processamento mais rápido.

Parâmetros (multipart/form-data)

Campo Tipo Obrigatório Descrição
file File (.html) ✅ Sim Arquivo HTML puro
options JSON String ❌ Não Opções do PDF (formato, margens, etc)
curl -X POST http://localhost:3333/api/exporter/generate/html \
  -F "file=@document.html" \
  -F 'options={"format":"A4","printBackground":true}'

Resposta (200 OK)

{
  "message": "PDF generated successfully from HTML file.",
  "pdf": "data:application/pdf;base64,JVBERi0xLjQKJ..."
}

🧪 Testar Endpoint

Selecione um arquivo .html ou .htm
Opções de formatação do PDF (opcional)
POST /generate/html-string Síncrono

Gerar PDF de String HTML

Gera um PDF a partir de HTML enviado como string no corpo da requisição. Não requer upload de arquivo.

ℹ️ Quando usar: HTML gerado dinamicamente no backend, sem necessidade de arquivo, ideal para APIs.

Parâmetros (application/json)

Campo Tipo Obrigatório Descrição
html String ✅ Sim String contendo o HTML completo
options Object ❌ Não Opções do PDF (formato, margens, etc)
curl -X POST http://localhost:3333/api/exporter/generate/html-string \
  -H "Content-Type: application/json" \
  -d '{
    "html": "

Hello World

", "options": {"format": "A4"} }'

Resposta (200 OK)

{
  "message": "PDF generated successfully from HTML string.",
  "pdf": "data:application/pdf;base64,JVBERi0xLjQKJ..."
}

🧪 Testar Endpoint

Cole o HTML completo aqui
Opções de formatação do PDF (opcional)