Geliştirici iş akışları

Kuyruklar ve işler için toplu PDF oluşturma API'si

Sisteminiz parçalama, retry, idempotency ve depolamayı yönetirken kuyruk-safe JSON Render veya Template Render iş akışlarıyla çok sayıda PDF üretin.

ANA API Template Render
ENDPOINT /api/v1/template-render
SİSTEMLER iş kuyruğu / SaaS backend'i / ERP dışa aktarma servisi / faturalama worker'ı
Çözülecek iş

İşi güvenli isteklere bölerek, her belgeyi veya şablon veri öğesini gPdf'e göndererek ve dönen PDF'i kendi sisteminizde saklayarak ya da teslim ederek kuyruktan veya planlanmış işten çok sayıda PDF render etmek.

Bu API ne zaman kullanılır

  • Faturaları, hesap ekstrelerini, etiketleri veya raporları planlı ya da olay tetiklemeli toplu iş içinde üretmeniz gerekiyor.
  • Kararlı bir şablonunuz var ve endpoint limitleri içinde birden çok data öğesi gönderebiliyorsunuz.
  • Browser worker çalıştırmadan kuyruk dostu render işlemi istiyorsunuz.
  • Deduplication, retry ve çıktı depolamayı kendi sisteminiz yönetebiliyor.

Neyin yerine geçmez

  • gPdf'in toplu iş zamanlayıcı, kuyruk, depolama sistemi veya idempotency kaydı olmasını istiyorsunuz.
  • Yayınlanmış rate-limit header'ları veya sunucu tarafı idempotency-key sözleşmesi gerekiyor.
  • Bir kampanyadaki her belgeyi tek sınırsız istekle render etmek istiyorsunuz.

Hangi endpoint çağrılır

ANA

/api/v1/template-render

Template Render bu iş akışı için varsayılan yoldur.

İKİNCİL 1

/api/v1/pdf/render

İş akışı ilgili API yoluna, template sözleşmesine veya capability sorgusuna ihtiyaç duyduğunda kullanın.

Minimum request

POST /api/v1/template-render - iki fatura verisi öğesiyle küçük toplu iş.

{
  "template_id": "invoice",
  "data": [
    {
      "invoice_number": "INV-2026-101",
      "date_of_issue": "2026-05-29",
      "bill_to_name": "Buyer A",
      "subtotal": "$50.00",
      "total": "$50.00",
      "amount_due": "$50.00",
      "items": []
    },
    {
      "invoice_number": "INV-2026-102",
      "date_of_issue": "2026-05-29",
      "bill_to_name": "Buyer B",
      "subtotal": "$75.00",
      "total": "$75.00",
      "amount_due": "$75.00",
      "items": []
    }
  ]
}

gPdf neyi üstlenir

  • Her JSON Render veya Template Render isteği için PDF render işlemi.
  • Belgelenmiş public limitler içinde Template Render data array'leri.
  • Kuyruk worker'lara uygun hızlı, stateless render yanıtları.
  • Ortak request ID ve error envelope davranışı.

Sisteminiz neyi yönetir

  • Kuyruk tasarımı, parçalama, conpara birimi, retry, tekilleştirme ve çıktı depolama.
  • Business object seçimi, şablon seçimi ve teslimat iş akışı.
  • Backoff politikası, uyarı sistemi ve kısmi arıza sonrası toparlanma.

Production kontrol listesi

  1. Her istek belgelenmiş item ve payload limitleri içinde kalacak şekilde işi parçalara ayırın.
  2. Her istek için bir X-Request-Id üretin ve bunu job ID'nizle eşleyin.
  3. Yalnızca ağ veya 5xx hatalarını sınırlı exponential backoff ile retry edin.
  4. Payload değişmeden 4xx doğrulama hatalarını retry etmeyin.
  5. Çıktı PDF'lerini veya kaynak veriyi saklama politikanıza göre saklayın.

İddia sınırları

  • gPdf render API'dir; kuyruk veya depolama katmanı değildir.
  • Public API bugün rate-limit header'ları veya sunucu tarafı idempotency key yayınlamaz.
  • Retry işlemlerini güvenli hale getirmek sizin sisteminizin sorumluluğudur.

Toplu oluşturma bir entegrasyon desenidir

Toplu PDF oluşturma ayrı bir endpoint değildir. Kuyruğunuzun public render API’lerini kullanma biçimidir. İşleri küçük, gözlemlenebilir ve retry açısından güvenli tutun.

Tekrarlanan yerleşimlerda Template Render genellikle en temiz sözleşmeyi sağlar. Özel yerleşim’lu programatik belgelerde JSON Render kullanılmaya devam eder.

SSS

gPdf toplu iş job API sağlar mı?
Ayrı bir toplu iş zamanlayıcı sunulmaz. Kendi kuyruğunuzdan veya worker sisteminizden JSON Render ya da Template Render kullanın.
Template Render birden çok data öğesi kabul eder mi?
Evet, public endpoint limitleri içinde kabul eder. Daha büyük işleri isteklere bölün.
Retry kime ait?
Retry, backoff, tekilleştirme ve idempotency sizin sisteminize aittir. gPdf izlenebilirlik için request ID'leri geri yansıtır.
Tek istekte çok farklı yerleşim render edebilir miyim?
Yerleşim veya template_id farklıysa ayrı istekler kullanın. Her isteği basit ve izlenebilir tutun.