Production sistemleri için Shopify PDF’leri API
Shopify PDF’leri çıktısını yapılandırılmış backend verilerinden tarayıcı olmadan üretin; gPdf PDF rendering’i üstlenir, iş kuralları sisteminizde kalır.
/api/v1/pdf/render Shopify PDF’leri çıktısını yapılandırılmış veriden tekrarlanabilir PDF olarak üretmek. gPdf PDF’i render eder; veri anlamı ve süreç durumu sisteminizde kalır.
Bu API ne zaman kullanılır
- Backend’inizde Shopify PDF’leri verisi zaten var ve kararlı bir PDF yanıtı gerekiyor.
- Operasyon belgesi için Chromium veya HTML-to-PDF kullanmak istemiyorsunuz.
- Reprint, audit veya batch için tekrarlanabilir çıktı gerekiyor.
Neyin yerine geçmez
- gPdf kargo satın almaz, vergi beyan etmez, dış sipariş oluşturmaz ve mali sistem değildir.
- Veri doğrulama, iş kuralları veya marketplace entegrasyonlarının yerine geçmez.
Hangi endpoint çağrılır
/api/v1/pdf/render
JSON Render bu iş akışı için varsayılan yoldur.
/api/v1/template-render
İş akışı ilgili API yoluna, template sözleşmesine veya capability sorgusuna ihtiyaç duyduğunda kullanın.
Minimum request
/api/v1/pdf/render - Shopify PDF’leri
{
"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 }
]
}
]
}
gPdf neyi üstlenir
- Yapılandırılmış request üzerinden Shopify PDF’leri için PDF rendering.
- Request’e göre metin, tablo, çizgi, barkod, sayfa, metadata ve çıktı ayarları.
- Retry, reprint ve audit için deterministik çıktı.
Sisteminiz neyi yönetir
- Shopify PDF’leri için doğru veri, iş kuralları ve operasyon durumu.
- Kimlik doğrulama, kalıcı kayıt, dış workflow ve alıcı sistem doğrulamaları.
Production checklist
- Gerçek veri ve PDF’i tüketecek sistemlerle test edin.
- Support, audit ve reprint için request ID ve doğrulama kanıtlarını saklayın.
- Onaylı layout birden fazla sistemde kullanılacaksa template’e taşıyın.
İddia sınırları
- gPdf operasyonel PDF render eder; resmi marketplace connector veya OMS değildir.
- Siparişler, fulfillment, marketplace API çağrıları ve müşteri kuralları sisteminizdedir.
API şekli
Shopify PDF’leri API, gPdf public API’leri üzerinde çalışan bir production workflow’dur. Request veriyi, layout’u, settings’i ve render edilecek PDF parçalarını açıkça tarif eder. gPdf PDF’i üretir; iş olayının semantiği sisteminizde kalır.
Endpoint seçimi
Bu workflow için varsayılan endpoint /api/v1/pdf/render. Layout onaylandıktan sonra Template Render kullanın. E-Invoice Render yalnızca EN 16931 CII XML gömülü Factur-X / ZUGFeRD PDF/A-3b paketleme gerektiğinde kullanılır.
Production öncesi doğrulama
Shopify PDF’leri çıktısını gerçek veriyle ve downstream sistemlerle doğrulayın. Support, audit ve reprint için request ID, render edilen çıktı ve doğrulama kanıtlarını saklayın.
FAQ
- Bu ayrı bir endpoint mi?
- Shopify PDF’leri API, workflow’u gPdf’in public API’lerinden birine bağlar. Sayfa hangi path’in çağrılacağını ve request’in neyi taşıyacağını açıklar.
- Templates kullanabilir miyim?
- Evet. Layout değişirken JSON Render, layout onaylandıktan ve callers yalnızca iş verisi gönderdikten sonra Template Render kullanın.
- Production öncesi neyi doğrulamalıyım?
- Gerçek veriyle ve workflow’daki yazıcı, scanner, validator, muhasebe sistemi veya marketplace ile doğrulayın.