Anleitungen

Auf einen Blick

Die Anleitungen zeigen, wie Sie NextPDF in die Ausführungsumgebung Ihres Codes einbinden. Dieser Tab beginnt mit der Checkliste für den Produktivbetrieb und behandelt anschließend fünf Bereiche in der Reihenfolge ihrer Einführung: Framework- und Renderer-Integrationen, den NextPDF-Connect-Server, das Python-SDK, die Entwicklung von Engine-Erweiterungen und die Fehlerbehebung. Jeder der folgenden Abschnitte beginnt mit der jeweiligen Hub-Seite und führt anschließend die Seiten auf, die Sie voraussichtlich am häufigsten verwenden.

Wenn Sie ein kopierbares, aufgabenorientiertes Recipe brauchen, verwenden Sie das Cookbook. Für die verifizierte API-Oberfläche und die Support-Matrizen nutzen Sie die Referenz.

Wählen Sie einen Startpunkt

Wenn Sie mit einem PHP-Framework arbeiten, beginnen Sie mit Integrationen. Wenn Ihre Aufrufer remote laufen, in einer anderen Sprache geschrieben sind oder als Agenten der künstlichen Intelligenz (KI) agieren, starten Sie mit NextPDF Connect oder dem Python-SDK. Wenn Sie die Engine selbst erweitern, beginnen Sie mit Die Engine erweitern.

Integrationen

Acht Pakete verbinden die Kern-Engine mit Frameworks, Browser-Renderern, Edge-Diensten, Build-Tools und Legacy-Migrationspfaden. Alle Paketabschnitte folgen derselben Handbuchstruktur – Überblick, Installation, Schnellstart, Konfiguration, API, Entwickleranleitung, Produktiveinsatz, Sicherheit und Fehlerbehebung –, sodass Sie sich nach dem ersten Abschnitt auch in den weiteren schnell zurechtfinden.

Seite	Verwendung
Integrationen	Die Erweiterungskarte und die Auswahlanleitung. Lesen Sie diese Seite zuerst, wenn Sie ein Paket auswählen möchten.
Index der Integrations-APIs	Zeigt, welche Erweiterungs-API-Seite welche Oberfläche für Frameworks, Renderer, Transporte und Build-Tools behandelt.
NextPDF für Laravel	Der Adapter für das Laravel-Framework.
NextPDF für Symfony	Der Adapter für das Symfony-Framework.
NextPDF für CodeIgniter	Der Adapter für das CodeIgniter-Framework.
NextPDF Artisan	Die Chrome-Renderer-Brücke für HTML-Rendering in Browserqualität.
NextPDF Cloudflare	Der Edge-Deployment-Pfad auf Cloudflare.
NextPDF Gotenberg	Die Gotenberg-Renderer-Brücke.
TCPDF-Kompatibilität	Der Kompatibilitäts-Shim für Codebasen, die von TCPDF migrieren.
NextPDF Backport Builder	Das Build-Tool für ältere PHP-Laufzeiten.

NextPDF Connect

Mit dem Paket nextpdf/server betreiben Sie die Engine als dauerhaft laufenden Dienst mit deterministischer Tool-Registry. Diese wird über das Model Context Protocol (MCP), Representational State Transfer (REST) und gRPC bereitgestellt und durch ein Bestätigungs-Gate mit Mensch-in-der-Schleife-Prüfung für Tools mit hohem Risiko abgesichert.

Seite	Verwendung
NextPDF Connect	Die Hub-Seite des Abschnitts mit Konzepten, Konfiguration und Serverbetrieb.
Connect – Überblick	Die Paketgrenze und die drei Transporte.
Connect – Schnellstart	Ein erster ausführbarer MCP-Handshake und die dazu passende REST-Render-Anfrage.
Connect-Konfiguration	Die MCP-YAML-Datei und die NEXTPDF_*-Umgebungsvariablen.
Connect API-Referenz	Alle registrierten Tools, jedes gRPC-Symbol, jeder Eintrag im Fehlermodell und jedes Ratenlimit.
Connect-Deployment	RoadRunner-Worker-Profile, Docker und Redis-basierte Stores.
Connect: Sicherheit und Betrieb	Authentifizierung, Transportsicherheit und das Bedrohungsmodell.

Zu jedem Transport gibt es eine eigene Referenzseite.

Seite	Verwendung
MCP-Transport	JSON-RPC-2.0-Framing über Standardeingabe und -ausgabe.
REST-Transport	Der OpenAPI-3.1-Vertrag, Bearer-Authentifizierung und stufenweise freigegebene Routen.
gRPC-Transport	Der Dienst nextpdf.connect.v1, Server-Streaming und Metadaten-Authentifizierung.

Python-SDK

Zitierfähige PDF-Extraktion für Python-Anwendungen, Agenten und die Kommandozeile auf Basis eines NextPDF-Connect-Endpunkts.

Seite	Verwendung
Python-SDK	Der Hub des Abschnitts für das Python-Paket nextpdf.
Überblick über das Python-SDK	Was das SDK leistet und wie es sich in Connect einordnet.
Schnelleinstieg in das Python-SDK	Installieren Sie das Paket mit pip install nextpdf und richten Sie einen Client für Ihren Server ein.
Python-SDK-API-Referenz	Die Client-Klassen, Methoden und typisierten Ergebnisse.
Python-CLI	Die Kommandozeilenschnittstelle für Extraktions-Workflows.
Python-MCP-Server	Stellen Sie das SDK für Agenten bereit, die MCP sprechen.

Die Engine erweitern

Über das öffentliche Service Provider Interface (SPI) können Sie Funktionen hinzufügen, ohne einen Fork zu erstellen: Verträge für Schriften, Layout-Engines, Event-Listener und Signatur-Backends, jeweils mit ausdrücklichem Stabilitätsversprechen.

Seite	Verwendung
Erweiterungen entwickeln	Was Sie erweitern können und welches Stabilitätsversprechen dafür gilt.
SPI-Stabilitätsregeln	Der Abwärtskompatibilitätsvertrag, auf den sich Ihre Erweiterung verlassen kann.
Eigene Schriftarten: der Vertrag der FontRegistry	Eigene Schriften registrieren und bereitstellen.
Eigene Layout-Engines und Text-Interception	Layoutverhalten ersetzen oder abfangen.
Action-Trigger und Event-Listener	Den Lebenszyklus eines Dokuments beobachten und darauf reagieren.
KMS-Provider-Vertrag	Stellen Sie Schlüssel aus Ihrem eigenen Key Management Service (KMS) bereit.

Fehlerbehebung

Die Einträge führen Sie vom Symptom zur Lösung und stützen sich auf die eigene Ausnahmetaxonomie der Engine. Beginnen Sie mit dem beobachteten Verhalten, nicht mit einem Klassennamen.

Seite	Verwendung
Fehlerbehebung	Die Hub-Seite der Wissensdatenbank: wie Einträge aufgebaut sind und wo Sie einsteigen.
Fehlerbehebung: Schriftarten und Tagging	Fehler bei der Schrifteinbettung und beim Struktur-Tagging.
Fehlerbehebung: Verschlüsselung und Berechtigungen	Fehler bei Verschlüsselung, Passwort und Berechtigungen.
Fehlerbehebung: Speicher und Performance	Speicherobergrenzen und Durchsatzprobleme.
Fehlerbehebung: PDF/A- und PDF/UA-Validierung	Fehler bei der Validierung für Archivierung und Barrierefreiheit.
Fehlerbehebung: Signaturen und Zeitstempel	Fehler bei der Validierung von Signaturen und Zeitstempeln.

Siehe auch

• Cookbook – aufgabenorientierte Recipes für PHP, Connect und Integrationen.
• Referenz – die verifizierte API-Oberfläche, die Support-Matrizen und die Fehlerreferenz.
• Migration zu NextPDF – für den Umstieg von einer anderen PDF-Bibliothek im Tab „Erste Schritte“.
• NextPDF von innen betrachtet – die Insider-Essays dazu, warum sich die Engine so verhält.