Developer-workflows

API voor batchgewijze PDF-generatie voor wachtrijen en taken

Genereer veel PDF's via wachtrijbestendige JSON Render- of Template Render-processen, terwijl uw systeem chunking, retries, idempotentie en opslag beheert.

PRIMAIRE API Template Render
ENDPOINT /api/v1/template-render
SYSTEMEN taakwachtrij / SaaS-backend / ERP-exportservice / facturatiewerker
Taak om op te lossen

Render veel PDF's vanuit een wachtrij of geplande taak door werk op te splitsen in veilige requests, elk document of elk template-data-item naar gPdf te sturen en de geretourneerde PDF in uw eigen systeem op te slaan of af te leveren.

Wanneer deze API past

  • U moet facturen, overzichten, etiketten of rapporten genereren in een geplande of eventgestuurde batch.
  • U hebt een stabiele template en kunt meerdere data-items binnen de endpointlimieten versturen.
  • U hebt wachtrijvriendelijke rendering nodig zonder browserwerkers te draaien.
  • Uw systeem kan deduplicatie, retries en opslag van output beheren.

Wat dit niet vervangt

  • U verwacht dat gPdf de batchplanner, wachtrij, opslaglaag of idempotentielog van uw systeem is.
  • U hebt gepubliceerde rate-limit headers of een server-side idempotency-key-contract nodig.
  • U wilt iedere PDF in een campagne met een enkele onbegrensde request renderen.

Welk endpoint aanroepen

PRIMAIR

/api/v1/template-render

Template Render is het standaardpad voor deze workflow.

SECUNDAIR 1

/api/v1/pdf/render

Gebruik dit wanneer de workflow een verwant API-pad, templatecontract of capability lookup nodig heeft.

Minimale request

POST /api/v1/template-render - kleine batch met twee factuurdata-items.

{
  "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": []
    }
  ]
}

Wat gPdf afhandelt

  • PDF-rendering voor elke JSON Render- of Template Render-request.
  • Template Render-data-arrays binnen de gedocumenteerde publieke limieten.
  • Snelle stateless renderresponses die geschikt zijn voor wachtrijwerkers.
  • Gedeeld gedrag voor request-ID's en foutresponsstructuren.

Wat uw systeem beheert

  • Wachtrijontwerp, chunking, concurrency, retries, deduplicatie en opslag van output.
  • Selectie van businessobjecten, templatekeuze en afleverproces.
  • Backoffbeleid, alarmering en herstel na gedeeltelijke fouten.

Productiechecklist

  1. Splits werk op zodat elke request binnen de gedocumenteerde item- en datalimieten blijft.
  2. Genereer een X-Request-Id per request en koppel die aan uw taak-ID.
  3. Probeer alleen netwerk- of 5xx-fouten opnieuw met begrensde exponentiële backoff.
  4. Probeer 4xx-validatiefouten niet opnieuw zonder de requestdata te wijzigen.
  5. Sla output-PDF's of brondata op volgens uw bewaarbeleid.

Grenzen van de claim

  • gPdf is de render-API, niet de wachtrij- of opslaglaag.
  • De publieke API publiceert op dit moment geen rate-limit headers of server-side idempotency keys.
  • Uw systeem moet retries veilig maken.

Batchgeneratie is een integratiepatroon

Batchgewijze PDF-generatie is geen apart endpoint. Het is de manier waarop uw wachtrij de publieke render-API’s gebruikt. Houd taken klein, observeerbaar en veilig opnieuw uitvoerbaar.

Voor herhaalde layouts biedt Template Render meestal het duidelijkste contract. Voor programmatische documenten met aangepaste layouts blijft JSON Render beschikbaar.

FAQ

Biedt gPdf een batchjob-API?
Er is geen aparte batchplanner beschikbaar. Gebruik JSON Render of Template Render vanuit uw eigen wachtrij of werkersysteem.
Kan Template Render meerdere data-items accepteren?
Ja, binnen de publieke endpointlimieten. Splits grotere taken op over meerdere requests.
Wie beheert retries?
Uw systeem beheert retries, backoff, deduplicatie en idempotentie. gPdf geeft request-ID's terug voor traceerbaarheid.
Kan ik veel verschillende layouts in een request renderen?
Gebruik aparte requests wanneer layouts of template-ID's verschillen. Houd elke request eenvoudig en traceerbaar.