API dla etykiet wysyłkowych PDF 4x6
Generuj gotowe do druku PDF etykiet wysyłkowych 4x6 z JSON zamówienia, z wektorowymi kodami kreskowymi, rozmiarami stron etykiet i deterministycznymi reprintami w magazynie.
/api/v1/pdf/render Renderować PDF w rozmiarze etykiety na podstawie danych zamówienia, odbiorcy, usługi i śledzenia, aby backend magazynu lub ecommerce mógł niezawodnie drukować tę samą etykietę 4x6 podczas realizacji zamówienia i deterministycznie odtworzyć ją przy reprintach.
Kiedy użyć tej API
- Twój system ma już numer śledzenia, adres docelowy, tekst usługi i payload kodu kreskowego.
- Potrzebujesz wyjścia PDF dla procesów z drukarkami termicznymi Zebra, SATO, Honeywell albo podobnymi.
- Chcesz używać wektorowych modułów kodu kreskowego zamiast rastrowych obrazów wklejonych do PDF.
- Ten sam payload ma generować tę samą etykietę przy reprintach i jako dowód audytowy.
Czego nie zastępuje
- Musisz kupić przesyłkę, wycenić wysyłkę albo utworzyć etykietę przewoźnika przez konto przewoźnika.
- Potrzebujesz endpointu zastępującego ZPL. gPdf zwraca PDF, nie język komend drukarki.
- Potrzebujesz certyfikacji etykiety przewoźnika od gPdf. Testy skanowania i akceptacji przewoźnika pozostają po Twojej stronie.
Który endpoint wywołać
/api/v1/pdf/render
JSON Render to domyślna ścieżka dla tego procesu.
/api/v1/template-render
Użyj, gdy proces wymaga powiązanej ścieżki API, kontraktu szablonu albo sprawdzenia capabilities.
Minimalny request
POST /api/v1/pdf/render - minimalna etykieta 4x6 z kodem śledzenia.
{
"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
- Strony PDF w rozmiarze etykiety, w tym procesy 4x6 cali.
- Wektorowe renderowanie kodów kreskowych dla treści etykiet przewoźnika i magazynu.
- Tekst, bloki adresowe, oznaczenia usługi, linie, ramki i opcjonalne powiązanie z szablonem.
- Deterministyczne wyjście PDF dla magazynowych reprintów.
Co kontroluje Twój system
- Konto przewoźnika, zakup przesyłki, wybór usługi i utworzenie numeru śledzenia.
- Poprawne payloady kodów kreskowych, tekst czytelny dla człowieka, adresy i dane routingu.
- Konfigurację drukarki, materiał etykiet, testy skanowania i kontrole akceptacji przewoźnika.
Checklist produkcyjny
- Wydrukuj etykiety testowe na rzeczywistym modelu drukarki i docelowym materiale etykiet.
- Zweryfikuj skuteczność skanowania kodu kreskowego przy docelowym DPI i dystansie skanera.
- Przechowuj źródłowe dane przesyłki albo zwrócony PDF zgodnie z polityką reprintów.
- Użyj Template Render, gdy układ etykiety jest zatwierdzony i ponownie używany między systemami.
- Trzymaj logikę specyficzną dla przewoźnika poza żądaniem renderowania.
Granice deklaracji
- gPdf renderuje PDF etykiety; nie kupuje przesyłek i nie komunikuje się bezpośrednio z przewoźnikami.
- gPdf nie jest organem certyfikującym etykiety przewoźników.
- API zwraca PDF, nie ZPL, EPL ani inny strumień komend drukarki termicznej.
Kształt API dla etykiet wysyłkowych
Strony etykiet wysyłkowych nie są osobnym endpointem przewoźnika. Wywołujesz JSON Render ze stroną w rozmiarze etykiety, blokami tekstu, liniami, opcjonalnymi obrazami i elementami kodów kreskowych. Dla powtarzalnych etykiet opublikuj zatwierdzony układ jako szablon i wywołuj Template Render z danymi przesyłki.
To utrzymuje jasną granicę odpowiedzialności. gPdf odpowiada za renderowanie PDF i rysowanie kodów kreskowych. Twój system odpowiada za transakcję z przewoźnikiem, stan przesyłki i semantykę payloadu.
JSON Render kontra Template Render
Użyj JSON Render, gdy system fulfillment generuje pełny układ albo gdy zespół operacyjny nadal dostraja współrzędne. Użyj Template Render, gdy magazyn zatwierdził stabilny układ etykiety i każdy wywołujący powinien wysyłać te same pola danych.
Obie ścieżki zwracają PDF. Różnica polega na tym, czy wywołujący opisuje układ
w każdym żądaniu, czy odwołuje się do opublikowanego template_id.
Testy druku mają znaczenie
Jakość etykiety termicznej jest fizyczna. Waliduj wyjście na rzeczywistym materiale etykiet, rzeczywistych drukarkach i rzeczywistych skanerach. Poprawność payloadu kodu kreskowego, quiet zones, zaczernienie drukarki i reguły specyficzne dla przewoźnika są odpowiedzialnością produkcyjną poza API renderowania.
FAQ
- Czy gPdf tworzy dla mnie etykiety przewoźnika?
- Nie. Przewoźnik albo Twój system wysyłkowy tworzy przesyłkę przewoźnika i payload kodu kreskowego. gPdf renderuje te dane jako etykietę PDF.
- Czy mogę używać Template Render do etykiet wysyłkowych?
- Tak. Użyj JSON Render podczas projektowania lub testowania etykiety, a potem przejdź na Template Render, gdy układ jest stabilny i wywołujący mają wysyłać tylko dane.
- Czy gPdf zwraca ZPL?
- Nie. Publiczne API renderowania zwracają PDF. Jeśli Twoja ścieżka druku wymaga ZPL, przekonwertuj albo skieruj PDF poza gPdf.
- Co zweryfikować przed produkcją?
- Wydrukuj na rzeczywistej drukarce i materiale etykiet, zeskanuj kod kreskowy produkcyjnymi skanerami i potwierdź, że tekst oraz payloady specyficzne dla przewoźnika pochodzą z Twojego systemu wysyłkowego.