Stable document contract-এর জন্য Template PDF API
Repeated layout একবার owner করে ERP, OMS, WMS বা SaaS caller-দের reuse করার জন্য stable template_id ও data array থেকে PDF render করুন।
/api/v1/template-render প্রতিটি request-এ caller-দের page, coordinate ও layout element বর্ণনা করতে না বলে stable template_id এবং business data array পাঠিয়ে repeated PDF render করুন।
কখন এই API ব্যবহার করবেন
- Document layout approved এবং একাধিক caller বা job-এ reuse হচ্ছে।
- Caller-দের coordinate-level layout JSON নয়, business data পাঠানো উচিত।
- Invoice, packing list, shipping label বা custom template output দরকার।
- Active template revision caller-এর বাইরে control করতে চান।
এটি কী replace করে না
- আপনি এখনও layout design করছেন। Coordinate ও field stable হওয়া পর্যন্ত JSON Render ব্যবহার করুন।
- Arbitrary HTML-to-PDF conversion দরকার।
- Embedded CII XML-সহ e-invoice PDF/A-3b packaging দরকার।
কোন endpoint call করবেন
/api/v1/template-render
Template Render এই workflow-এর default path।
/api/v1/pdf/render
Workflow-তে related API path, template contract অথবা capabilities lookup দরকার হলে ব্যবহার করুন।
নূন্যতম request
POST /api/v1/template-render - template থেকে এক invoice render।
{
"template_id": "invoice",
"data": [
{
"invoice_number": "INV-2026-001",
"date_of_issue": "2026-05-29",
"date_due": "2026-06-28",
"issuer_name": "Acme Cloud Inc.",
"issuer_address": "88 Harbor Rd, Long Beach, CA",
"bill_to_name": "Receiver Inc.",
"bill_to_address": "123 Main St, Los Angeles, CA",
"subtotal": "$100.00",
"total": "$100.00",
"amount_due": "$100.00",
"items": [
{
"description": "Service A",
"qty": 1,
"unit_price": "$100.00",
"amount": "$100.00"
}
]
}
]
}
gPdf কী করে
- Stable template_id দিয়ে template lookup।
- Active template-এর against প্রতিটি data item render করা।
- Public endpoint limit-এর মধ্যে rendered page একক PDF-এ concatenate করা।
- Shared authentication, request ID এবং error envelope behavior।
আপনার system-এর দায়িত্ব
- Template selection, field mapping, business data এবং caller authorization।
- Template publication workflow, change communication এবং test coverage।
- অনেক document render করার সময় chunking, queueing এবং retry।
Production checklist
- template_id-কে opaque stable contract হিসেবে treat করুন।
- Template Render call করার আগে data field validate করুন।
- Active template এবং representative data-এর জন্য golden-PDF test রাখুন।
- Public Template Render limit অনুযায়ী large batch split করুন।
- Traceability-এর জন্য template_id, request ID এবং business object ID log করুন।
দাবির সীমা
- Template Render নিজে design tool নয়; template আগে publish করা থাকতে হবে।
- Template থেকে missing business data gPdf অনুমান করে না।
- Template Render, E-Invoice Render endpoint-এর replacement নয়।
Template Render হলো production contract layer
Layout design চলাকালীন JSON Render আদর্শ। Layout যখন contract হয়ে যায়, তখন
Template Render ব্যবহার করার layer। Caller template_id এবং data পাঠায়; active
template document structure own করে।
এতে caller ছোট থাকে এবং template change review, test ও rollout করা সহজ হয়।
FAQ
- JSON Render-এর বদলে কখন Template Render ব্যবহার করব?
- Layout approved হয়ে গেলে এবং caller-দের শুধু business data পাঠানো উচিত হলে Template Render ব্যবহার করুন।
- template_id কি stable?
- হ্যাঁ। Template API docs-এ template_id-কে stable caller-facing identifier হিসেবে বর্ণনা করা হয়েছে।
- এক request-এ কি একাধিক data item render করা যায়?
- হ্যাঁ, public endpoint limit-এর মধ্যে Template Render data array গ্রহণ করে।
- Template Render কি e-invoice তৈরি করতে পারে?
- না। Factur-X এবং ZUGFeRD PDF/A-3b packaging E-Invoice Render endpoint ব্যবহার করে।