Developer workflows

प्रोडक्शन सिस्टम के लिए टेम्पलेट PDF API

template PDF को structured backend data से बिना browser render करें. gPdf PDF output संभालता है और business rules आपके system में रहते हैं.

PRIMARY API Template Render
ENDPOINT /api/v1/template-render
SYSTEMS operations backend / finance system / compliance workflow / document service
काम जो पूरा करना है

template PDF को structured data से repeatable PDF के रूप में generate करना. gPdf document render करता है; data semantics और workflow state आपका system रखता है.

यह API कब इस्तेमाल करें

  • Backend में template PDF data पहले से है और stable PDF response चाहिए.
  • Operational document के लिए Chromium या HTML-to-PDF avoid करना है.
  • Reprint, audit या batch के लिए repeatable output चाहिए.

यह क्या replace नहीं करता

  • gPdf postage खरीदना, tax filing, external order creation या fiscal system का काम नहीं करता.
  • Data validation, business rules या marketplace integrations को replace नहीं करता.

कौन सा endpoint call करें

PRIMARY

/api/v1/template-render

Template Render इस workflow का default path है.

SECONDARY 1

/api/v1/pdf/render

जब workflow को related API path, template contract या capabilities lookup चाहिए, तब इसका उपयोग करें.

Minimal request

/api/v1/template-render - template PDF

{
  "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 क्या handle करता है

  • Structured request से template PDF का PDF rendering.
  • Request के हिसाब से text, tables, lines, barcodes, pages, metadata और output options.
  • Retry, reprint और audit के लिए deterministic output.

आपका system क्या own करता है

  • template PDF का सही data, business rules और operation state.
  • Authentication, storage, external workflows और receiver validation.

Production checklist

  1. Real data और PDF consume करने वाले systems के साथ test करें.
  2. Support, audit और reprint के लिए request IDs और validation evidence रखें.
  3. Approved layout को template बनाएं जब कई systems उसे reuse करें.

Claim boundaries

  • gPdf request से PDF render करता है; product workflow, database या business validation replace नहीं करता.
  • Data semantics, retries, storage और final acceptance आपके system में रहते हैं.

API shape

टेम्पलेट PDF API public gPdf APIs पर बना production workflow है. Request data, layout, settings और render होने वाले PDF parts स्पष्ट करता है. gPdf PDF बनाता है; business event का मतलब आपका system रखता है.

Endpoint choice

इस workflow का default endpoint /api/v1/template-render है. Layout approve होकर systems में reuse हो तो Template Render use करें. EN 16931 CII XML embedded Factur-X / ZUGFeRD PDF/A-3b packaging के लिए ही E-Invoice Render use करें.

Production से पहले validation

template PDF को real data और downstream systems से validate करें. Support, audit और reprint के लिए request IDs, rendered output और validation evidence रखें.

FAQ

क्या यह अलग endpoint है?
टेम्पलेट PDF API workflow को public gPdf API path से map करता है. Page बताता है कौन सा path call करना है और request क्या own करता है.
क्या templates use कर सकते हैं?
हाँ. Layout बदल रहा हो तो JSON Render use करें; layout approve हो जाए और callers सिर्फ business data भेजें तो Template Render use करें.
Production से पहले क्या validate करें?
Real data और workflow के printer, scanner, validator, accounting system या marketplace receiver से validate करें.