API label pengiriman untuk sistem produksi
Buat label pengiriman dari data backend terstruktur tanpa browser. gPdf menangani PDF rendering; aturan bisnis tetap berada di sistem Anda.
/api/v1/pdf/render Membuat label pengiriman sebagai PDF yang dapat direproduksi dari data terstruktur. gPdf merender dokumen; sistem Anda tetap memegang makna data dan status proses.
Kapan memakai API ini
- Backend sudah memiliki data label pengiriman dan membutuhkan respons PDF yang stabil.
- Anda ingin menghindari Chromium atau HTML-to-PDF untuk dokumen operasional.
- Anda membutuhkan output berulang untuk reprint, audit, atau batch.
Apa yang tidak digantikan
- gPdf tidak membeli ongkir, melaporkan pajak, membuat pesanan eksternal, atau menjadi sistem fiskal.
- Tidak menggantikan validasi data, aturan bisnis, atau integrasi marketplace.
Endpoint yang dipanggil
/api/v1/pdf/render
JSON Render adalah jalur default untuk workflow ini.
/api/v1/template-render
Gunakan saat workflow butuh jalur API terkait, kontrak template, atau capability lookup.
Request minimal
/api/v1/pdf/render - label pengiriman
{
"pages": [
{
"size": "label_4_6_in",
"elements": [
{
"type": "text",
"x": 4,
"y": 6,
"content": "SHIP TO",
"style": { "font_size": 8, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 4,
"y": 13,
"content": "Acme Warehouse\n1200 Logistics Pkwy\nMemphis TN 38116",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
},
{
"type": "barcode",
"format": "code128",
"content": "1Z999AA10123456784",
"x": 4,
"y": 62,
"width": 92,
"height": 22,
"barcode_text": { "enabled": true, "position": "bottom" }
}
]
}
]
}
Yang ditangani gPdf
- Rendering PDF label pengiriman dari request terstruktur.
- Teks, tabel, garis, barcode, halaman, metadata, dan opsi output sesuai request.
- Output deterministik untuk retry, reprint, dan audit.
Yang dikelola sistem Anda
- Data label pengiriman yang benar, aturan bisnis, dan status operasional.
- Autentikasi, penyimpanan, workflow eksternal, dan validasi dengan sistem penerima.
Checklist produksi
- Uji dengan data nyata dan sistem yang akan menerima PDF.
- Simpan request ID dan bukti validasi untuk support, audit, dan reprint.
- Jadikan layout yang disetujui sebagai template ketika dipakai banyak sistem.
Batas klaim
- gPdf merender PDF label; tidak membeli ongkir, membuat shipment, atau mensertifikasi carrier.
- Payload, printer, stok label, routing, dan scan test tetap milik sistem Anda.
Bentuk API
API label pengiriman adalah workflow produksi di atas public APIs gPdf. Request menjelaskan data, layout, settings, dan bagian PDF yang perlu dirender. gPdf membuat PDF; sistem Anda menjaga semantik event bisnis.
Pilihan endpoint
Endpoint default untuk workflow ini adalah /api/v1/pdf/render. Gunakan Template Render setelah layout disetujui dan dipakai ulang. Gunakan E-Invoice Render hanya untuk paket Factur-X / ZUGFeRD PDF/A-3b dengan EN 16931 CII XML tertanam.
Validasi sebelum produksi
Validasi label pengiriman dengan data nyata dan downstream systems. Simpan request ID, output, dan bukti validasi untuk support, audit, dan reprint.
FAQ
- Apakah ini endpoint terpisah?
- API label pengiriman memetakan workflow ke API publik gPdf. Halaman ini menjelaskan path yang dipanggil dan data yang harus dimiliki request.
- Bisa memakai templates?
- Bisa. Gunakan JSON Render saat layout masih berubah; gunakan Template Render setelah layout disetujui dan callers hanya mengirim data bisnis.
- Apa yang harus divalidasi sebelum produksi?
- Validasi dengan data nyata dan printer, scanner, validator, sistem akuntansi, atau marketplace sesuai workflow.