Dokumentation

Diese Dokumentation beschreibt die lokale, selbst gehostete PDF-Engine. Alle Funktionen laufen ausschließlich auf Ihrem eigenen Server.

API-Referenz

POST /api/v1/render
Content-Type: application/json

{
  "title": "Schadenmeldung",
  "subtitle": "Datum: 2026-01-10",

  "fields": [
    { "label": "Schadenart", "value": "Wasserschaden" },
    { "label": "Beschreibung", "value": "Wasser tropft aus der Decke" },
    { "label": "Name", "value": "Max Mustermann" },
    { "label": "E-Mail", "value": "max@example.de" }
  ],

  "footer": "Generiert am 2026-01-11"
}

200 OK
Content-Type: application/pdf

Installation

Installation auf Ihrem eigenen Linux-Server:

sudo apt update
sudo apt install -y curl
curl -fL https://raw.githubusercontent.com/onprem-pdf/api-installer/main/install.txt | sudo bash

==========================================================
Installation abgeschlossen!

PDFGuard API:
http://SERVER-IP:8080/pdfguard/api/v1/render

Administrationsoberfläche:
http://SERVER-IP:8080/pdfguard/

Admin Login:
Benutzer: pdfguard
Passwort: **************

Bitte speichern Sie dieses Passwort jetzt.
Es wird nicht erneut angezeigt.
==========================================================

Die Administrationsoberfläche wird automatisch mit einem zufällig generierten Passwort abgesichert. Es existieren keine Standard-Zugangsdaten.

Danach läuft die API lokal unter:

http://localhost:8080/api/v1/render

Administrationsoberfläche

Nach der Installation stellt PDFGuard eine lokale Administrationsoberfläche bereit. Diese dient zur Überwachung des Systems und zur Verwaltung der Lizenz.

Die Oberfläche ist erreichbar unter:

http://SERVER-IP:8080/pdfguard/

Beim ersten Zugriff fordert der Browser zur Anmeldung auf. Die Zugangsdaten werden bei der Installation automatisch erzeugt und einmalig im Terminal angezeigt.

Benutzer: pdfguard
Passwort: **************

Die Administrationsoberfläche zeigt unter anderem:

• Status des PDF-Services (aktiv / inaktiv)
• Aktiver Lizenztyp (Lite oder On-Prem Engine)
• Versionsinformation der Engine
• Den lokalen API-Endpunkt

Die Administrationsoberfläche ist ausschließlich lokal erreichbar und durch HTTP Basic Authentication geschützt.

Lizenzverwaltung

Die Lizenz wird über die Administrationsoberfläche verwaltet. Nach dem Kauf erhalten Sie einen Lizenzschlüssel, der einmalig eingegeben wird.

Öffnen Sie dazu im Browser:

http://SERVER-IP:8080/pdfguard/

Nach der Anmeldung geben Sie den Lizenzschlüssel im Bereich Lizenz ein und aktivieren diesen.

Die Engine schaltet daraufhin automatisch von Lite auf On-Prem Engine um. Ein Neustart ist nicht erforderlich.

Offline & Security

• Kein Internet erforderlich
• Keine Telemetrie
• Keine externen Server
• Alle Daten bleiben in Ihrem Netzwerk

DSGVO & Datenschutz

Die OnPrem PDF API wurde speziell für den Einsatz in datenschutzsensiblen Umgebungen entwickelt.

• Es werden keinerlei personenbezogene Daten gespeichert.
• Alle eingehenden JSON-Daten werden ausschließlich zur PDF-Erzeugung im Arbeitsspeicher verarbeitet.
• Nach der PDF-Erstellung werden die Daten sofort verworfen.
• Es existiert keine Datenbank, kein Logging von Inhalten und keine Protokollierung der Nutzdaten.
• Es findet keine Übertragung an externe Server statt.

Damit eignet sich die Software für Behörden, Versicherungen, medizinische Einrichtungen und alle Umgebungen mit hohen Datenschutzanforderungen.

FAQ

Geht das ohne Internet?
Ja. Die PDF-Erstellung läuft vollständig auf Ihrem eigenen Server.

Werden Daten übertragen?
Nein. Es findet keinerlei externe Kommunikation statt.

Ist die Sandbox identisch?
Ja. Die Sandbox stellt dieselbe API bereit, nur auf einem öffentlichen Testserver.