Basisadresse

Basisadresse

Alle Endpunkte liegen unter diesem Präfix. Bei einer lokalen Installation gilt standardmäßig die folgende Adresse.

https://api.pdfgine.com/api/v1

Seitennavigation bei Listenendpunkten

Fünf Listenendpunkte unterstützen Seitennavigation: /history einer Vorlage, /assets, /marketplace/templates, /templates und /components. Jeder akzeptiert optional limit (1–200) und before und liefert weiterhin ein einfaches Array. Bestehende Leser müssen daher nicht geändert werden.

Ohne limit erhalten Sie höchstens 200 Zeilen. Gibt es weitere, enthält die Antwort einen Link-Header mit rel="next". Folgen Sie diesem Link, statt die nächste URL selbst zu bauen: Der Cursor ist im Verlauf eine Versionsnummer, bei Ressourcen eine Ressourcen-ID und andernorts ein undurchsichtiger Wert; nur der Header kennt die passende Form. Bei /marketplace/templates enthält der Cursor auch die Filter und wird bei Änderungen an Suche, Kategorie oder Sprache ungültig. Das ist beabsichtigt, da derselbe Cursor sonst auf eine andere Liste zeigen würde. Die übrigen Listenendpunkte liefern bereits begrenzte Sammlungen. Eine gekürzte Antwort enthält außerdem X-PDFgine-List-Truncated: true und X-PDFgine-List-Limit; beide fehlen auf der letzten Seite.

Die maschinenlesbare Beschreibung

Alles auf diesen Seiten wird auch als OpenAPI-3.0-Dokument veröffentlicht. Nutzen Sie es mit Ihrem Clientgenerator, Postman oder Editor, um Pfade, Anfrageinhalte und Beispielnutzdaten ohne manuelles Kopieren zu erhalten.

https://api.pdfgine.com/openapi/v1.json

Das Dokument wird aus der laufenden API erzeugt. Es beschreibt daher die tatsächlich aufgerufene Version und nicht eine Version, an deren Dokumentation sich jemand erinnert hat.