Developer workflows

Template PDF API für wiederholbare Dokumente

Template PDF API: veröffentlichte Layouts über template_id und data[] befüllen, ohne Browser-Rendering und mit klarer Grenze zwischen gPdf-Rendering und Ihren Geschäftsdaten.

PRIMÄRE API Template Render
ENDPOINT /api/v1/template-render
SYSTEME SaaS-Backend / ERP-Integration / OMS / WMS / Job-Queue
Aufgabe im Workflow

veröffentlichte Layouts über template_id und data[] befüllen. Ihr System liefert Daten und Regeln; gPdf rendert daraus reproduzierbare PDF-Ausgabe.

Wann diese API passt

  • Ihr System besitzt die Daten für Template-basierte PDFs bereits und braucht eine PDF-Antwort.
  • Sie wollen Template Render über /api/v1/template-render statt eines browserbasierten HTML-zu-PDF-Flows nutzen.
  • Layout, Barcodes, Text und Metadaten sollen reproduzierbar aus strukturierten Daten entstehen.
  • Vor dem Produktivgang sollen Payloads im Playground oder in CI reproduzierbar geprüft werden.

Was sie nicht ersetzt

  • Sie brauchen willkürliche HTML-zu-PDF-Konvertierung mit Chromium.
  • Sie erwarten, dass gPdf geschäftliche oder rechtliche Bedeutung aus Rohdaten ableitet.
  • Ein veröffentlichter template_id-Vertrag ist passender als Layoutdaten pro Request.

Welchen Endpoint aufrufen

PRIMÄR

/api/v1/template-render

Template Render ist der Standardpfad für diesen Workflow.

SEKUNDÄR 1

/api/v1/pdf/render

Nutzen Sie dies, wenn der Workflow den zugehörigen API-Pfad, einen Template-Vertrag oder eine Capability-Abfrage braucht.

Minimaler Request

/api/v1/template-render - minimaler Request für Template-basierte PDFs.

{
  "template_id": "invoice",
  "data": [
    {
      "invoice_number": "INV-2026-001",
      "date_of_issue": "2026-05-29",
      "date_due": "2026-06-28",
      "issuer_name": "Acme Cloud Inc.",
      "issuer_address": "88 Harbor Rd, Long Beach, CA",
      "bill_to_name": "Receiver Inc.",
      "bill_to_address": "123 Main St, Los Angeles, CA",
      "subtotal": "$100.00",
      "total": "$100.00",
      "amount_due": "$100.00",
      "items": [
        {
          "description": "Service A",
          "qty": 1,
          "unit_price": "$100.00",
          "amount": "$100.00"
        }
      ]
    }
  ]
}

Was gPdf übernimmt

  • Rendering von Template-basierte PDFs aus strukturierten Requests.
  • PDF-Seiten, Text, Tabellen, Linien, Formen, Bilder und Vektor-Barcodes nach Bedarf.
  • Deterministische PDF-Ausgabe für Reprints, Audits und Backend-Automatisierung.
  • Einheitliche API-Fehlerfläche mit API-XXX-Code und req_id bei Fehlern.

Was Ihr System verantwortet

  • Fachliche Daten, Feldmapping und Semantik der Ausgabe.
  • Validierung, Idempotenz, Dateinamen, Speicherung und Nachverfolgung nach der Antwort.
  • Steuer-, Compliance-, Kunden- oder Plattformregeln vor dem Rendering.

Produktions-Checkliste

  1. Request IDs und Timeouts für produktive Aufrufe setzen.
  2. Payloads gegen OpenAPI, Dokumentation oder Golden-PDF-Tests prüfen.
  3. API-Basis-URL und Bearer Token konfigurierbar halten und nicht im Code speichern.
  4. Template-Vertrag, Feldnamen und Versionierung vor dem Rollout fixieren.
  5. Validierungs- und Reprint-Nachweise dort speichern, wo Ihr System sie braucht.

Aussagegrenzen

  • gPdf rendert Template-basierte PDFs; die fachliche Richtigkeit bleibt bei Ihrem System.
  • Die Seite beschreibt den passenden gPdf-API-Pfad, keinen zusätzlichen workflow-spezifischen Endpoint.
  • Externe Zertifizierung, Akzeptanz und operative Freigaben liegen außerhalb des Renderers.

Wie dieser Workflow in gPdf passt

Template PDF API ist ein Produktionsworkflow auf Basis der öffentlichen gPdf-APIs. Der Request beschreibt die Ausgabe explizit: Daten, Layout, Einstellungen und die Teile, die als PDF gerendert werden sollen. gPdf übernimmt das Rendering, nicht die fachliche Entscheidung hinter den Daten.

API-Pfad und Verantwortungsgrenze

In der Regel ist Template Render über /api/v1/template-render der richtige Einstieg. Ihr System bleibt verantwortlich für Stammdaten, Validierung, Retention und fachliche Regeln. Dadurch bleibt der Vertrag klar: gPdf erzeugt das PDF, Ihre Anwendung steuert Bedeutung und Prozess.

Produktionsreife

Testen Sie Template-basierte PDFs mit echten Daten, Druckern, Scannern, Validierern oder Empfängersystemen, je nach Workflow. Speichern Sie Request IDs und Validierungsnachweise so, dass Support, Audit und Reprint später nachvollziehbar bleiben.

FAQ

Ist Template PDF API ein eigener Endpoint?
Nein. Diese Seite erklärt, wie Sie /api/v1/template-render und die zugehörigen gPdf APIs für diesen Workflow einsetzen.
Was muss mein System liefern?
Ihr System liefert Geschäftsdaten, Feldmapping, Validierung und alle Regeln vor dem Rendering. gPdf übernimmt die PDF-Erzeugung.
Wann sollte ich Template Render nutzen?
Nutzen Sie Template Render, wenn das Layout stabil ist und Aufrufer nur noch Daten über template_id und data[] senden sollen.
Was prüfe ich vor Produktion?
Testen Sie reale Daten, Grenzfälle, Validierung und die nachgelagerten Systeme, die das PDF lesen, drucken oder archivieren.