OnPremPDF API

API-Endpunkt

Der Endpunkt erzeugt synchron ein PDF-Dokument und liefert dieses direkt als HTTP-Antwort zurück.

POST http://{servername}:8080/pdfguard/api/v1/render
Content-Type: application/json

Request-Parameter

Templates

PDF-Templates definieren das visuelle Layout und die Struktur der erzeugten Dokumente. Eine Kundenumgebung kann ein oder mehrere Templates enthalten.

Das zu verwendende Template kann über das optionale Feld template im Request-Body ausgewählt werden. Wird kein Template angegeben, wird automatisch das default-Template verwendet.

{
  "template": "default"
}

Beispiel für ein kundenspezifisches Template

Unten sehen Sie ein Beispiel für ein kundenspezifisches Template. Benutzerdefinierte Vorlagen können komplexe Layouts enthalten, wie tabellenbasierte Dokumente, Rechnungen, Zertifikate, Berichte oder behördliche Formulare.

Code-Beispiele

import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.charset.StandardCharsets;

public class Example {

  public static void main(String[] args) throws Exception {

    String json =
      "{"
    + "\"template\":\"default\","
    + "\"title\":\"Schadenmeldung\","
    + "\"subtitle\":\"Datum: 2026-01-10\","
    + "\"fields\":["
    + "  {\"label\":\"Name\",\"value\":\"Max Mustermann\"},"
    + "  {\"label\":\"E-Mail\",\"value\":\"max@example.de\"},"
    + "  {\"label\":\"Schadenart\",\"value\":\"Wasserschaden\"}"
    + "],"
    + "\"footer\":\"Erstellt mit OnPremPDF\""
    + "}";

    URL url = new URL("https://sandbox.onprempdf.com/pdfguard/api/v1/render");
    HttpURLConnection con = (HttpURLConnection) url.openConnection();

    con.setRequestMethod("POST");
    con.setRequestProperty("Content-Type", "application/json");
    con.setDoOutput(true);

    try (OutputStream os = con.getOutputStream()) {
      os.write(json.getBytes(StandardCharsets.UTF_8));
    }

    int status = con.getResponseCode();
    System.out.println("HTTP Status: " + status);

    if (status != 200) {
    throw new RuntimeException("HTTP error: " + status);
    }

    try (InputStream is = con.getInputStream()) {
      Files.copy(is, Path.of("document.pdf"), java.nio.file.StandardCopyOption.REPLACE_EXISTING);
    }

    System.out.println("PDF erfolgreich erzeugt.");
  }

}

import requests

payload = {
  "template": "default",
  "title": "Schadenmeldung",
  "subtitle": "Datum: 2026-01-10",
  "fields": [
    { "label": "Name", "value": "Max Mustermann" },
    { "label": "E-Mail", "value": "max@example.de" },
    { "label": "Schadenart", "value": "Wasserschaden" }
  ],
  "footer": "Erstellt mit OnPremPDF"
}

r = requests.post(
  "https://sandbox.onprempdf.com/pdfguard/api/v1/render",
  json=payload
)

r.raise_for_status()

with open("dokument.pdf", "wb") as f:
  f.write(r.content)

$payload = @{
  template = "default"
  title = "Schadenmeldung"
  subtitle = "Datum: 2026-01-10"
  fields = @(
    @{ label = "Name"; value = "Max Mustermann" }
    @{ label = "E-Mail"; value = "max@example.de" }
    @{ label = "Schadenart"; value = "Wasserschaden" }
  )
  footer = "Erstellt mit OnPremPDF"
} | ConvertTo-Json -Depth 5

Invoke-RestMethod `
  -Uri "https://sandbox.onprempdf.com/pdfguard/api/v1/render" `
  -Method POST `
  -ContentType "application/json" `
  -Body $payload `
  -OutFile "dokument.pdf"

curl -X POST https://sandbox.onprempdf.com/pdfguard/api/v1/render \
  -H "Content-Type: application/json" \
  -d '{
    "template": "default",
    "title": "Schadenmeldung",
    "subtitle": "Datum: 2026-01-10",
    "fields": [
      { "label": "Name", "value": "Max Mustermann" },
      { "label": "E-Mail", "value": "max@example.de" },
      { "label": "Schadenart", "value": "Wasserschaden" }
    ],
    "footer": "Erstellt mit OnPremPDF"
  }' \
  --output document.pdf

const payload = {
  template: "default",
  title: "Schadenmeldung",
  subtitle: "Datum: 2026-01-10",
  fields: [
    { label: "Name", value: "Max Mustermann" },
    { label: "E-Mail", value: "max@example.de" },
    { label: "Schadenart", value: "Wasserschaden" }
  ],
  footer: "Erstellt mit OnPremPDF"
};

fetch("https://sandbox.onprempdf.com/pdfguard/api/v1/render", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify(payload)
})
.then(response => {
  if (!response.ok) {
    throw new Error("HTTP Fehler: " + response.status);
  }
  return response.blob();
})
.then(blob => {
  // Browser: PDF öffnen
  const url = URL.createObjectURL(blob);
  window.open(url);

  // Optional: später freigeben
  // URL.revokeObjectURL(url);
})
.catch(err => {
  console.error("PDF-Erzeugung fehlgeschlagen:", err);
});