واجهة API لـ فواتير PDF في أنظمة الإنتاج
أنشئ فواتير PDF من بيانات backend منظمة بدون متصفح، مع فصل واضح بين PDF rendering الذي ينفذه gPdf ومنطق العمل في نظامك.
/api/v1/pdf/render إنشاء فواتير PDF كملف PDF قابل لإعادة الإنتاج من بيانات منظمة. يتولى gPdf إخراج PDF، بينما يبقى معنى البيانات وحالة workflow في نظامك.
متى تستخدم هذه API
- لدى backend بيانات فواتير PDF بالفعل ويحتاج إلى استجابة PDF ثابتة.
- تريد تجنب Chromium أو HTML-to-PDF في مستندات التشغيل.
- تحتاج إلى output قابل للإعادة للطباعة، التدقيق أو المعالجة الدفعية.
ما الذي لا تستبدله
- gPdf لا يشتري الشحن، لا يقدّم ضرائب، لا ينشئ أوامر خارجية ولا يعمل كنظام ضريبي.
- لا يستبدل data validation أو business rules أو تكاملات marketplace.
أي endpoint يجب استدعاؤه
/api/v1/pdf/render
JSON Render هو المسار الافتراضي لهذا workflow.
/api/v1/template-render
استخدمه عندما يحتاج workflow إلى API مرتبط، عقد template، أو capabilities lookup.
/api/v1/e-invoice/render
استخدمه عندما يحتاج workflow إلى API مرتبط، عقد template، أو capabilities lookup.
Request مختصر
/api/v1/pdf/render - فواتير PDF
{
"pages": [
{
"size": "a4",
"elements": [
{
"type": "text",
"x": 20,
"y": 24,
"content": "Invoice INV-1007",
"style": { "font_size": 18, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 20,
"y": 42,
"content": "Bill to: Example Customer\nAmount due: USD 245.00",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
},
{
"type": "line",
"x1": 20,
"y1": 62,
"x2": 190,
"y2": 62
}
]
}
]
}
ما يتولاه 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/pdf/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.