Documentation API

Créez des workflows PDF avec une API prévisible.

Référence officielle des endpoints DocuForge, de l’authentification et des erreurs. Tout reste aligné avec la console pour garder un modèle mental simple.

Vue d’ensemble

DocuForge expose une API REST pour l’authentification, la gestion des modèles, le rendu, les assets, la facturation et les éditions assistées par IA. Tous les endpoints protégés exigent un JWT dans l’en‑tête Authorization.

Réponses typées

Chaque endpoint renvoie un schéma stable et un objet d’erreur cohérent.

Authentification

Les rendus en production utilisent des clés API : envoyez la clé via l’en‑tête X-API-Key pour /v1/render.

X-API-Key: docu_live_your_api_key

Démarrage rapide

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

Rendu

Production rendering endpoints are available under the consumer API surface.

POST /v1/render

Rend un template publié avec une clé X-API-Key. Renvoie un blob PDF.

Erreurs

L’API renvoie des erreurs JSON au format stable. Utilisez le code d’erreur pour mapper l’UI.

401 unauthorized

Missing or invalid API key.

402 payment_required

Limite du plan atteinte. Proposez une mise à niveau.

429 rate_limited

Ralentir et réessayer après le délai indiqué.

500 internal_error

Erreur inattendue. Réessayez ou contactez le support.

Sécurité et gouvernance

DocuForge fournit des bases solides pour l'authentification, la sécurité des requêtes et l'intégrité des 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.

Intégration MCP

Connectez DocuForge aux clients compatibles MCP pour générer des PDF via des appels d'outils structurés.

Démarrage rapide MCP

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

Auth: Bearer token

Header: Authorization: Bearer <MCP_SERVER_TOKEN>

Outils MCP principaux

  • docuforge_get_usage
  • docuforge_list_templates
  • docuforge_get_template
  • docuforge_render_pdf
  • docuforge_render_preview_pdf

Prêt à construire ?

Ouvrez la console pour livrer vos PDFs, ou revenez sur la page d’accueil pour revoir la plateforme.