API PDF dla Shopify dla aplikacji i procesów backendowych
Wywołuj gPdf z aplikacji Shopify albo zaplecza ecommerce, aby generować PDF zamówień, faktury, dokumenty pakowania, zwroty i etykiety z mapowanych danych Shopify.
/api/v1/pdf/render Użyj aplikacji Shopify albo backendu ecommerce, aby zmapować dane zamówienia, klienta, produktu, realizacji i zwrotu do JSON gPdf albo danych szablonu, a następnie zwrócić deterministyczne PDF bez sugerowania natywnej integracji z oficjalnym katalogiem aplikacji Shopify.
Kiedy użyć tej API
- Budujesz aplikację Shopify, prywatny backend albo proces realizacji zamówień, który może wywoływać zewnętrzne API.
- Twoja aplikacja już odbiera dane zamówień, realizacji, klientów albo produktów z Shopify.
- Potrzebujesz faktur, dokumentów pakowania, dokumentów zwrotu, etykiet magazynowych albo załączników PDF.
- Chcesz stabilnej umowy `template_id` dla układów dokumentów specyficznych dla sprzedawcy.
Czego nie zastępuje
- Oczekujesz, że gPdf będzie oficjalną aplikacją Shopify albo publicznym wpisem w Shopify App Store.
- Potrzebujesz, aby gPdf instalował się w sklepie sprzedawcy, obsługiwał OAuth albo bezpośrednio subskrybował webhooki.
- Potrzebujesz od gPdf stawek wysyłki, zakupu etykiet nadawczych, zarządzania stanem magazynowym albo interfejsu sprzedawcy.
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/template-render - backend aplikacji wysyła zmapowane dane zamówienia Shopify do opublikowanego szablonu.
{
"template_id": "packing_list",
"data": [
{
"order_number": "#1042",
"customer_name": "Example Buyer",
"ship_to": "1200 Market St, San Francisco, CA",
"items": [
{ "sku": "TSHIRT-BLK-M", "name": "Black T-shirt", "quantity": 2 },
{ "sku": "MUG-WHT", "name": "White mug", "quantity": 1 }
]
}
]
}
Co obsługuje gPdf
- Renderowanie PDF z JSON pochodzącego z danych Shopify i zmapowanego przez backend Twojej aplikacji.
- Template Render dla układów dokumentów dopasowanych do sprzedawcy albo marki.
- Kody kreskowe, kody QR, tabele, sumy, obrazy, etykiety i struktury dokumentów pakowania.
- Bezstanowe generowanie PDF przez publiczne API gPdf.
Co kontroluje Twój system
- Kod aplikacji Shopify, OAuth, webhooki, interfejs sprzedawcy i dystrybucję w katalogu aplikacji.
- Mapowanie danych zamówień, realizacji, klientów, zwrotów, produktów i podatków.
- Konfigurację sprzedawcy, wybór szablonu, dostarczenie, przechowywanie i ponawianie prób.
Checklist produkcyjny
- Przechowuj poświadczenia Shopify i tokeny API gPdf w backendzie, nie w kodzie przeglądarkowym.
- Mapuj dane Shopify do jawnych danych renderowania albo schematu danych szablonu.
- Używaj Template Render dla układów specyficznych dla sprzedawcy po ich zatwierdzeniu.
- Przechowuj wygenerowane PDF albo dane źródłowe zgodnie z procesem sprzedawcy.
- Udokumentuj, że integracja polega na wywoływaniu gPdf przez Twoją aplikację, a nie na oficjalnej aplikacji Shopify od gPdf.
Granice deklaracji
- Nie deklaruj publicznej, oficjalnej aplikacji Shopify, dopóki taki produkt nie istnieje.
- gPdf nie obsługuje Shopify OAuth, instalacji aplikacji, webhooków ani ustawień sprzedawcy.
- System wywołujący odpowiada za mapowanie danych Shopify i reguły biznesowe ecommerce.
Model integracji
Czysty model integracji z Shopify działa backend-do-backendu. Twoja aplikacja odbiera albo pobiera dane Shopify, mapuje je do DocumentRequest gPdf albo obiektu danych szablonu, wywołuje gPdf, a następnie zwraca lub przechowuje PDF zgodnie z procesem sprzedawcy.
Dzięki temu publiczne pozycjonowanie pozostaje precyzyjne: gPdf jest API do generowania PDF, które może wywoływać Twoja aplikacja Shopify. Nie jest publiczną, oficjalną aplikacją Shopify, chyba że taki osobny produkt istnieje.
Template Render pasuje do układów sprzedawców
PDF w ecommerce często stają się specyficzne dla sprzedawcy: branding, tabele pozycji, instrukcje zwrotu, bloki etykiet, notatki prezentowe i lokalizowany tekst. Template Render pozwala przechowywać te układy w opublikowanych szablonach, podczas gdy aplikacja wysyła tylko zmapowane dane zamówienia.
Logika platformy zostaje w aplikacji
OAuth, webhooki, ustawienia sprzedawcy, stan realizacji, zapasy, reguły zwrotów i dystrybucja w katalogu aplikacji pozostają w Twojej aplikacji Shopify. gPdf powinien otrzymać finalne dane renderowania i wygenerować PDF.
FAQ
- Czy gPdf jest oficjalną aplikacją Shopify?
- Nie. Ta strona jest przeznaczona dla aplikacji i backendów, które wywołują gPdf. Nie przedstawiaj gPdf jako oficjalnej integracji z Shopify App Store, dopóki taki produkt nie istnieje.
- Gdzie powinno odbywać się wywołanie API gPdf?
- Wywołuj gPdf z backendu albo serwera aplikacji, gdzie poświadczenia Shopify i tokeny API gPdf są chronione.
- Czy PDF dla Shopify powinny używać JSON Render czy Template Render?
- Używaj JSON Render dla własnych generowanych układów. Używaj Template Render, gdy układ sprzedawcy albo marki został zatwierdzony, a systemy wywołujące mają przesyłać tylko dane.
- Czy gPdf obsługuje webhooki Shopify?
- Nie. Twoja aplikacja odbiera webhooki, mapuje dane i decyduje, kiedy renderować dokument. gPdf renderuje wyłącznie żądanie PDF, które otrzymuje.