هل هذا endpoint منفصل؟

واجهة API لـ توليد PDF دفعي يربط workflow بمسار API عام في gPdf. توضح الصفحة أي path يجب استدعاؤه وما الذي يملكه request.

هل يمكن استخدام templates؟

نعم. استخدم JSON Render عندما يتغير layout، ثم Template Render بعد اعتماد layout وإرسال callers لبيانات العمل فقط.

ما الذي يجب التحقق منه قبل الإنتاج؟

تحقق ببيانات حقيقية وبالطابعات، الماسحات، validators، أنظمة المحاسبة أو marketplace حسب workflow.

Developer workflows

واجهة API لـ توليد PDF دفعي في أنظمة الإنتاج

أنشئ توليد PDF دفعي من بيانات backend منظمة بدون متصفح، مع فصل واضح بين PDF rendering الذي ينفذه gPdf ومنطق العمل في نظامك.

API الرئيسي Template Render

ENDPOINT /api/v1/template-render

الأنظمة backend تشغيلي / نظام مالي / workflow امتثال / خدمة مستندات

جرّب في Playground → اقرأ الوثائق

المهمة المطلوبة

إنشاء توليد PDF دفعي كملف PDF قابل لإعادة الإنتاج من بيانات منظمة. يتولى gPdf إخراج PDF، بينما يبقى معنى البيانات وحالة workflow في نظامك.

متى تستخدم هذه API

لدى backend بيانات توليد PDF دفعي بالفعل ويحتاج إلى استجابة PDF ثابتة.
تريد تجنب Chromium أو HTML-to-PDF في مستندات التشغيل.
تحتاج إلى output قابل للإعادة للطباعة، التدقيق أو المعالجة الدفعية.

ما الذي لا تستبدله

gPdf لا يشتري الشحن، لا يقدّم ضرائب، لا ينشئ أوامر خارجية ولا يعمل كنظام ضريبي.
لا يستبدل data validation أو business rules أو تكاملات marketplace.

أي endpoint يجب استدعاؤه

الرئيسي

/api/v1/template-render

Template Render هو المسار الافتراضي لهذا workflow.

ثانوي 1

/api/v1/pdf/render

استخدمه عندما يحتاج workflow إلى API مرتبط، عقد template، أو capabilities lookup.

Request مختصر

/api/v1/template-render - توليد PDF دفعي

{
  "template_id": "invoice",
  "data": [
    {
      "invoice_number": "INV-2026-101",
      "date_of_issue": "2026-05-29",
      "bill_to_name": "Buyer A",
      "subtotal": "$50.00",
      "total": "$50.00",
      "amount_due": "$50.00",
      "items": []
    },
    {
      "invoice_number": "INV-2026-102",
      "date_of_issue": "2026-05-29",
      "bill_to_name": "Buyer B",
      "subtotal": "$75.00",
      "total": "$75.00",
      "amount_due": "$75.00",
      "items": []
    }
  ]
}

ما يتولاه gPdf

PDF rendering لـ توليد PDF دفعي من request منظم.
النصوص، الجداول، الخطوط، الباركود، الصفحات، metadata وخيارات الإخراج حسب request.
Output حتمي للـ retry وإعادة الطباعة والتدقيق.

ما يملكه نظامك

البيانات الصحيحة لـ توليد PDF دفعي، قواعد العمل وحالة العملية.
Authentication، التخزين، workflows الخارجية والتحقق لدى النظام المستقبل.

Checklist الإنتاج

اختبر ببيانات حقيقية وبالأنظمة التي ستستهلك PDF.
احتفظ بـ request IDs وأدلة التحقق للدعم، التدقيق وإعادة الطباعة.
حوّل layout المعتمد إلى template عندما تعيد عدة أنظمة استخدامه.

حدود الادعاء

gPdf يرندر PDF من request؛ لا يستبدل product workflow أو database أو business validation.
Data semantics، retries، storage وfinal acceptance تبقى في نظامك.

شكل API

واجهة API لـ توليد PDF دفعي هو production workflow مبني على APIs العامة في gPdf. يصف request البيانات، layout، settings وأجزاء PDF المطلوب render لها. ينشئ gPdf ملف PDF؛ ويبقى معنى business event في نظامك.

اختيار endpoint

الـ endpoint الافتراضي لهذا workflow هو /api/v1/template-render. استخدم Template Render بعد اعتماد layout وإعادة استخدامه بين الأنظمة. استخدم E-Invoice Render فقط عند الحاجة إلى Factur-X / ZUGFeRD PDF/A-3b مع EN 16931 CII XML مدمج.

التحقق قبل الإنتاج

تحقق من توليد PDF دفعي ببيانات حقيقية وبالأنظمة downstream. احتفظ بـ request IDs، output وأدلة validation للدعم، التدقيق وإعادة الطباعة.

FAQ

هل هذا endpoint منفصل؟: واجهة API لـ توليد PDF دفعي يربط workflow بمسار API عام في gPdf. توضح الصفحة أي path يجب استدعاؤه وما الذي يملكه request.
هل يمكن استخدام templates؟: نعم. استخدم JSON Render عندما يتغير layout، ثم Template Render بعد اعتماد layout وإرسال callers لبيانات العمل فقط.
ما الذي يجب التحقق منه قبل الإنتاج؟: تحقق ببيانات حقيقية وبالطابعات، الماسحات، validators، أنظمة المحاسبة أو marketplace حسب workflow.