PDF z szablonu: API dla produkcji
Generowanie PDF z szablonu ze strukturalnych danych backendu, bez przeglądarki, z jasną granicą między gPdf renderingiem a regułami Twojego systemu.
/api/v1/template-render Generowanie PDF z szablonu jako powtarzalnego PDF ze strukturalnych danych. gPdf tworzy dokument; Twój system odpowiada za znaczenie danych i stan procesu.
Kiedy użyć tej API
- Backend ma już dane dla PDF z szablonu i potrzebuje stabilnej odpowiedzi PDF.
- Chcesz uniknąć Chromium lub HTML-to-PDF w dokumencie operacyjnym.
- Potrzebujesz powtarzalnego wyniku do reprintów, audytu lub batchy.
Czego nie zastępuje
- gPdf nie kupuje wysyłki, nie rozlicza podatków, nie tworzy zewnętrznych zamówień i nie jest systemem fiskalnym.
- gPdf nie zastępuje reguł biznesowych, walidacji danych ani integracji marketplace.
Który endpoint wywołać
/api/v1/template-render
Template Render to domyślna ścieżka dla tego workflow.
/api/v1/pdf/render
Użyj, gdy workflow potrzebuje powiązanej API, kontraktu szablonu albo sprawdzenia capabilities.
Minimalny request
/api/v1/template-render - PDF z szablonu
{
"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"
}
]
}
]
}
Co obsługuje gPdf
- Rendering PDF dla PDF z szablonu ze strukturalnego requestu.
- Tekst, tabele, linie, kody kreskowe, strony, metadane i opcje wyjścia zgodnie z requestem.
- Deterministyczny output dla retry, reprintów i audytu.
Co kontroluje Twój system
- Poprawne dane dla PDF z szablonu, reguły biznesowe i stan operacji.
- Autentykacja, przechowywanie, zewnętrzne workflow i walidacja u odbiorcy.
Checklist produkcyjny
- Testuj na prawdziwych danych i w systemach, które odbiorą PDF.
- Zachowuj request ID i dowody walidacji dla supportu, audytu i reprintów.
- Zamień zaakceptowany layout w template, gdy ma być współdzielony.
Granice deklaracji
- gPdf renderuje PDF z requestu; nie zastępuje workflow produktu, bazy danych ani walidacji biznesowej.
- Twój system odpowiada za semantykę danych, retries, przechowywanie i końcową akceptację.
Kształt API
API: PDF z szablonu to production workflow oparty na publicznych API gPdf. Request opisuje dane, layout, settings i części PDF do renderingu. gPdf tworzy PDF, a Twój system zachowuje semantykę zdarzenia biznesowego.
Wybór endpointu
Domyślny endpoint dla tego workflow to /api/v1/template-render. Template Render stosuj po zatwierdzeniu layoutu. E-Invoice Render tylko dla Factur-X / ZUGFeRD PDF/A-3b z osadzonym EN 16931 CII XML.
Walidacja przed produkcją
Waliduj PDF z szablonu na realnych danych i downstream-systemach. Zachowuj request ID, output i dowody walidacji dla supportu, audytu oraz reprintów.
FAQ
- Czy to osobny endpoint?
- API: PDF z szablonu mapuje workflow na publiczną API gPdf. Strona pokazuje, który path wywołać i co ma zawierać request.
- Czy można używać templates?
- Tak. JSON Render pasuje, gdy layout jeszcze się zmienia; Template Render po zatwierdzeniu layoutu i przy wysyłaniu samych danych biznesowych.
- Co zweryfikować przed produkcją?
- Sprawdź realne dane oraz downstream: drukarki, skanery, walidatory, księgowość albo marketplace.