PDF Blocks
PreiseSupport
Kostenlos starten
Seite öffnen

Übersicht der Aktionen

Was eine Aktion ist, der nach Fähigkeiten gruppierte Katalog und wie die Ausgabe einer Aktion zur Eingabe der nächsten wird.

Eine Aktion ist eine einzelne, reine Umwandlung eines PDFs, die als ein Endpoint bereitgestellt wird. Sie senden ein Dokument, die Aktion macht genau eine Sache damit (zusammenführen, mit einem Wasserzeichen versehen, verschlüsseln, drehen, aufteilen), und Sie erhalten das Ergebnis zurück. Aktionen halten keinen Zustand und teilen keinen Kontext; jeder Aufruf steht für sich. Genau diese Einheitlichkeit erlaubt es Ihnen, sie zu Pipelines zusammenzustecken.

Was eine Aktion ist

Jede Aktion ist ein POST an /v1/<action>, wobei <action> der technische Name aus den Tabellen unten ist. Alle folgen demselben Vertrag für Anfrage und Antwort: einem Anfragetext vom Typ multipart/form-data mit dem PDF-Eingabedokument im Feld file, authentifiziert über den Header X-API-Key. Die meisten geben ein einzelnes application/pdf zurück; die Familie der Aktionen zum Aufteilen gibt mehrere Dokumente zurück.

Der Katalog

Siebzehn Aktionen, nach Fähigkeiten gruppiert. Jede verweist auf ihre vollständige Referenz.

Zusammenführen und aufteilen

Aktion Route Was sie tut
Dokumente zusammenführen /v1/merge_documents Ein geordnetes Array von PDF-Dokumenten zu einem Dokument kombinieren.
Nach Seitenanzahl aufteilen /v1/split_by_page_count Ein PDF in aufeinanderfolgende Teile mit fester Seitenanzahl zerlegen.
An einer Seite aufteilen /v1/split_at_page Ein PDF an einer Trennstelle in zwei Teile aufteilen.
Nach Dateigröße aufteilen /v1/split_by_size Ein PDF in Teile zerlegen, die eine Grenze in Bytes jeweils nicht überschreiten.
In Seitengruppen aufteilen /v1/split_by_groups Ein PDF in Seitengruppen zerlegen, die Sie selbst festlegen.

Die vier Aktionen zum Aufteilen erzeugen jeweils mehrere Dokumente; die Verpackung wählen Sie mit dem Header Accept. Siehe Antwortformate.

Wasserzeichen

Aktion Route Was sie tut
Textwasserzeichen hinzufügen /v1/add_text_watermark Bis zu drei Zeilen gestalteten Text auf den Seiten aufbringen.
Bildwasserzeichen hinzufügen /v1/add_image_watermark Ein PNG- oder JPEG-Bild, etwa ein Logo, auf den Seiten aufbringen.

Passwörter und Sicherheit

Aktion Route Was sie tut
Passwort hinzufügen /v1/add_password Ein Dokument mit einem Passwort zum Öffnen und/oder einem Passwort für Berechtigungen verschlüsseln.
Passwort entfernen /v1/remove_password Ein Dokument entschlüsseln, dessen Passwort Sie kennen.
Einschränkungen hinzufügen /v1/add_restrictions Berechtigungs-Flags für Drucken, Kopieren und Bearbeiten setzen.
Einschränkungen entfernen /v1/remove_restrictions Die Berechtigungs-Flags eines Dokuments zurücksetzen.
Signaturen entfernen /v1/remove_signatures Digitale Signaturen entfernen, damit das Dokument bearbeitet werden kann.

Seiten

Aktion Route Was sie tut
Seiten extrahieren /v1/extract_pages Eine gewählte Menge von Seiten behalten und den Rest verwerfen.
Seiten entfernen /v1/remove_pages Eine gewählte Menge von Seiten verwerfen und den Rest behalten.
Seiten drehen /v1/rotate_pages Gewählte Seiten um ein Vielfaches von 90 Grad drehen.
Seitenreihenfolge umkehren /v1/reverse_pages Die Reihenfolge der Seiten komplett umkehren.
Seiten neu anordnen /v1/reorder_pages Seiten in eine vom Aufrufer angegebene Reihenfolge bringen.

Wie sich Aktionen zusammensetzen

Da jede Aktion ein PDF entgegennimmt und (bei Aktionen mit einer einzelnen Ausgabe) ein PDF zurückgibt, ist die Ausgabe einer Aktion eine gültige Eingabe für die nächste. Zwischen den Aufrufen wird nichts gespeichert, Sie setzen also zusammen, indem Sie Bytes weiterreichen: Halten Sie die Antwort einer Anfrage im Arbeitsspeicher und senden Sie sie als file der nächsten.

Eine typische Pipeline liest sich von links nach rechts:

merge_documents  →  add_text_watermark  →  add_password
   (many PDFs)         (one watermarked)      (one encrypted)

Der Leitfaden Aktionen verketten zeigt das durchgehend im Code, ohne die Festplatte zu berühren.

Einzelne Ausgabe oder mehrere Ausgaben

Die meisten Aktionen geben ein Dokument vom Typ application/pdf zurück. Die vier Aktionen zum Aufteilen geben viele zurück und lassen Sie über die Inhaltsaushandlung wählen, wie diese verpackt werden (ein ZIP-Archiv, ein JSON-Umschlag oder ein Antworttext vom Typ multipart/mixed). Dieser Mechanismus hat genau einen Ort: Antwortformate.