DocuForge logoDocuForge

Documentación API

Crea flujos PDF con una API predecible.

La referencia oficial de endpoints DocuForge, autenticación y errores. Todo está alineado con la consola para mantener un modelo mental claro.

Resumen

DocuForge expone una API REST para autenticación, gestión de plantillas, renderizado, assets, facturación y ediciones con IA. Los endpoints protegidos requieren un JWT en el header Authorization.

Respuestas tipadas

Cada endpoint devuelve un esquema estable y un objeto de error consistente.

Autenticación

Los renders en producción usan API keys: envía la clave en el header X-API-Key a /v1/render.

X-API-Key: docu_live_your_api_key

Inicio rápido

Render a production PDF from a published template ID and JSON data.

curl -X POST "$DOCUFORGE_API_URL/v1/render" \
  -H "X-API-Key: $DOCUFORGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "template_id": "tpl_live_123", "data": { "invoice_id": "1234" } }' \
  --output document.pdf

Renderizado

Production rendering endpoints are available under the consumer API surface.

POST /v1/render

Renderiza una plantilla publicada con X-API-Key. Devuelve un blob PDF.

Errores

La API devuelve errores JSON con un formato estable. Usa el código de error para estados de UI.

401 unauthorized

Missing or invalid API key.

402 payment_required

Límite del plan alcanzado. Sugiere una actualización.

429 rate_limited

Reduce el ritmo y reintenta tras el delay indicado.

500 internal_error

Error inesperado. Reintenta o contacta soporte.

Seguridad y gobernanza

DocuForge incluye bases practicas para autenticacion, seguridad de requests e integridad de webhooks.

  • TLS transport, authenticated APIs, and hardened defaults help teams clear security reviews without custom hardening projects.
  • Password-protected PDF delivery is built in for regulated workflows handling sensitive documents.
  • Credential and token handling defaults are designed to reduce leakage risk across render, billing, and webhook paths.
  • JWT and API-key auth paths are isolated by endpoint intent.
  • Stripe webhook signatures are verified before billing events are processed.
  • Outbound webhooks are signed with HMAC SHA-256 and retried with backoff.
  • Webhook URL creation enforces HTTPS in production.
  • Plan-aware rate limiting protects render, preview, and AI endpoints.
  • Validation middleware enforces request schemas with predictable error payloads.
  • Auth, billing, usage, and render mutation routes are explicitly non-cacheable.
  • MCP server access requires bearer token auth and optional allowed-origin checks.

Integracion MCP

Conecta DocuForge a clientes compatibles con MCP para generar PDFs con tool calls y flujos estructurados.

Inicio rapido MCP

Endpoint: https://mcp.docuforge.app/mcp

Auth: Bearer token

Header: Authorization: Bearer <MCP_SERVER_TOKEN>

Herramientas MCP principales

  • docuforge_get_usage
  • docuforge_list_templates
  • docuforge_get_template
  • docuforge_render_pdf
  • docuforge_render_preview_pdf

¿Listo para construir?

Abre la consola para empezar a enviar PDFs o vuelve a la landing para revisar la plataforma.