توثيق واجهة البرمجة

ابنِ تدفقات PDF عبر واجهة برمجية موثوقة.

المرجع الأساسي لنقاط النهاية في DocuForge والمصادقة ومعالجة الأخطاء. كل شيء مصمم ليبقى قريباً من الكونسول لتبقى الرؤية واضحة.

نظرة عامة

توفّر DocuForge واجهة REST للمصادقة وإدارة القوالب والرندر والأصول والفوترة وتعديلات الذكاء الاصطناعي. جميع نقاط النهاية المحمية تتطلب JWT ضمن ترويسة Authorization.

استجابات مُهيكلة

كل نقطة نهاية تُرجع مخططاً ثابتاً وكائناً متسقاً للأخطاء.

المصادقة

الرندر في الإنتاج يعتمد مفاتيح API: أرسل المفتاح في ترويسة X-API-Key عند /v1/render.

X-API-Key: docu_live_your_api_key

بدء سريع

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

الرندر

Production rendering endpoints are available under the consumer API surface.

POST /v1/render

ينشئ PDF لقالب منشور باستخدام X-API-Key. يعيد Blob PDF.

الأخطاء

تُرجع الواجهة أخطاء JSON بصيغة ثابتة. استخدم رمز الخطأ لتحديد حالة الواجهة.

401 unauthorized

Missing or invalid API key.

402 payment_required

تم الوصول إلى حد الخطة. اطلب الترقية.

429 rate_limited

خفّض السرعة وأعد المحاولة بعد التأخير المحدد.

500 internal_error

خطأ غير متوقع. أعد المحاولة أو تواصل مع الدعم.

الامان والحوكمة

يوفر DocuForge اساسا عمليا للمصادقة وسلامة الطلبات وتكامل الويب هوك.

  • 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.

تكامل MCP

اربط DocuForge مع العملاء الداعمين لـ MCP لتوليد PDF عبر استدعاءات ادوات مهيكلة.

بداية سريعة لـ MCP

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

Auth: Bearer token

Header: Authorization: Bearer <MCP_SERVER_TOKEN>

ادوات MCP الاساسية

  • docuforge_get_usage
  • docuforge_list_templates
  • docuforge_get_template
  • docuforge_render_pdf
  • docuforge_render_preview_pdf

جاهز للبناء؟

افتح الكونسول لبدء إرسال ملفات PDF، أو عد إلى صفحة الهبوط لمراجعة المنصة.