etykiet wysyłkowych: API dla produkcji
Generowanie etykiet wysyłkowych ze strukturalnych danych backendu, bez przeglądarki, z jasną granicą między gPdf renderingiem a regułami Twojego systemu.
/api/v1/pdf/render Generowanie etykiet wysyłkowych 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 etykiet wysyłkowych 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/pdf/render
JSON Render to domyślna ścieżka dla tego workflow.
/api/v1/template-render
Użyj, gdy workflow potrzebuje powiązanej API, kontraktu szablonu albo sprawdzenia capabilities.
Minimalny request
/api/v1/pdf/render - etykiet wysyłkowych
{
"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" }
}
]
}
]
}
Co obsługuje gPdf
- Rendering PDF dla etykiet wysyłkowych 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 etykiet wysyłkowych, 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 etykiety; nie kupuje wysyłki, nie tworzy shipment i nie certyfikuje akceptacji przewoźnika.
- Twój system odpowiada za payload, drukarki, nośnik etykiety, routing i testy skanowania.
Kształt API
API: etykiet wysyłkowych 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/pdf/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 etykiet wysyłkowych 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: etykiet wysyłkowych 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.