Produkt- und API-Leitfaden

Vorschaulinks

Viewer- und Einbettungseinstellungen

Konfigurieren Sie Darstellung, Titelsichtbarkeit und Seitennavigation in den Einstellungen des eingebetteten Viewers im Konto. Markenentfernung und Einbettung hängen von Tarifberechtigungen ab; prüfen Sie die angezeigte Verfügbarkeit.

Erlaubte Websites

Fügen Sie die Websites, auf denen Sie den Viewer einbetten, den erlaubten Websites hinzu. Einbettungsberechtigung und Freigabegültigkeit werden getrennt geprüft: Eine erlaubte Website reaktiviert keine abgelaufene oder widerrufene Freigabe. Verwenden Sie niemals API-Schlüssel in Browsercode oder iframe-URLs.

Vor der Freigabe prüfen

Testen Sie den Link unter den Bedingungen Ihres Empfängers. Prüfen Sie Seitenzahl, Diagramm- und Tabellenlayout, Downloadformate und Ablauf. Testen Sie auch die Einbettung auf einer nicht erlaubten Website. Eine funktionierende Kontovorschau allein belegt keinen externen Zugriff.

Erstellt einen zeitlich begrenzten Ansichtslink, den Kunden ohne Konto öffnen können. Ein Aufruf kann Downloadlinks für PDF und DOCX zurückgeben.

Anfrage 
curl -X POST https://api.pdfgine.com/api/v1/preview \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "templateCode": "invoice", "formats": ["pdf", "docx"], "data": { } }'
Antwort 
{
  "previewId": "prv_481fac83d9f14a4493021eb128d0876b",
  "previewUrl": "/p/prv_481fac83d9f14a4493021eb128d0876b",
  "expiresAt": "2026-08-29T13:23:43+00:00",
  "pageCount": 1,
  "downloads": [
    { "format": "pdf", "downloadUrl": "/api/v1/previews/prv_481f.../download/pdf?expires=...&token=..." },
    { "format": "docx", "downloadUrl": "/api/v1/previews/prv_481f.../download/docx?expires=...&token=..." }
  ]
}

Der Link enthält eine nicht erratbare Signatur und endet bei expiresAt.

Wie lange Dokumente verfügbar bleiben

PDFgine erstellt und liefert Dokumente; ob Sie ein erstelltes Dokument behalten, entscheiden Sie. Das Produkt speichert nur eigene Eingaben (Vorlagen, Markenressourcen) und temporäre Ausgaben. Jede Ausgabe bleibt für den in der Anfrage gewählten Zeitraum verfügbar: accessProfile: short 24 Stunden (Standard), standard 7 Tage, extended 30 Tage (7 und 30 Tage ab Go), quarter 90 Tage (Max). Ein Freigabelink bleibt so lange offen; ein Produktionsdokument (/render, /documents/render) kann in diesem Zeitraum über die API erneut heruntergeladen werden. Danach liefern Downloads 410 und die Ausgabe wird innerhalb von 24 Stunden gelöscht. Erstellungsdatensatz, Seitenzahl und Nutzungsdaten bleiben erhalten. Speichern Sie Dokumente für eine dauerhafte Aufbewahrung direkt nach der Erstellung in Ihrem eigenen System.

Links für neunzig Tage

Neben den Profilen standard und extended gibt es das Profil quarter, das Links 90 Tage gültig hält — etwa für einen Vertrag, den die Gegenseite ein ganzes Quartal erneut öffnen können muss. Es ist im höchsten Tarif verfügbar; jeder Tarif zeigt die erlaubten Profile in seinen Tarifberechtigungen.

Einen Link vorzeitig schließen

Ein Freigabelink endet normalerweise bei expiresAt. Soll das Dokument nicht mehr sichtbar sein, widerrufen Sie den Link: Die Antwort ist 204 und der Link funktioniert sofort nicht mehr.

cURL 
curl -i -X POST https://api.pdfgine.com/api/v1/previews/prv_481fac83d9f14a4493021eb128d0876b/revoke \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

HTTP/1.1 204 No Content

Häufige Fehler

  • Eine Vorschau wird mit 201 statt 200 erstellt; ein Widerruf liefert 204 ohne Inhalt. Ein Client, der jede Antwort als JSON liest, scheitert beim Widerruf.
  • accessProfile bestimmt die Linkgültigkeit. Längere Profile erfordern den passenden Tarif. quarter wird in einem Tarif ohne diese Berechtigung abgelehnt, nicht stillschweigend verkürzt.
  • Die Links in downloads enthalten Signatur und Ablaufzeit. Speichern Sie previewId statt dieser Adressen; gespeicherte Adressen funktionieren nach Ablauf nicht mehr.
  • Ein Widerruf schließt den Link, nicht das Dokument. Die Datei gehört weiterhin Ihnen und kann bis zum Ende der Aufbewahrung über die API heruntergeladen werden.
  • Eine Vorschau verbraucht Vorschauseiten, kein Produktionskontingent. Eine erneute Erstellung desselben Dokuments über /render wird separat nach Seiten abgerechnet.