PDF-Dokument verschlüsseln API
PDF4me Dokument schützen ist ein REST-Endpunkt, der eine PDF-Datei mit einem Passwort schützt und die Zugriffsmöglichkeiten der Empfänger einschränkt. Senden Sie die Datei als Base64-kodierte Datei per POST an /api/v2/Protect Mit einem Passwort und einer Berechtigungskennzeichnung erhalten Sie eine neue, AES-verschlüsselte PDF-Datei als Antwort. Drucken, Kopieren, Bearbeiten und Ausfüllen von Formularen sind nur auf Ihre ausdrückliche Zustimmung erlaubt.
Was dieser Endpunkt bewirkt
PDF4me Dokument schützen verschlüsselt ein PDF mit einem Passwort und setzt Berechtigungsflags in einem einzigen REST Anruf. Senden Sie die PDF als Base64Wählen Sie das Passwort und die zulässigen Aktionen (Drucken, Kopieren, Kommentieren, Formularausfüllen) und erhalten Sie ein neues Passwort. AES-verschlüsselt PDF in der Antwort. Die angewendete Verschlüsselung ist AES-128 oder AES-256 pro PDF Spezifikation, geeignet für GDPR, HIPAAund andere Compliance-getriebene Arbeitsabläufe.
Authentifizierung Ihres API Anfrage
Jeder PDF4me REST API Der Anruf muss Ihre API Schlüssel im Authorization Header. Erstellen oder wählen Sie einen Schlüssel im Entwickler-Dashboard aus und verwalten Sie ihn serverseitig. Geben Sie ihn niemals im Browsercode preis.
Wichtige Fakten, die Sie nicht verpassen sollten
Passwort Feldtore dokumentieren die Öffnung. pdfPermission Die Aufzählung steuert, welche Aktionen Benutzer nach dem Öffnen des Dokuments ausführen können. Verwenden Sie beide zusammen, um ein Dokument bereitzustellen. PDF das ein Passwort erfordert UND das Drucken oder Kopieren deaktiviert.pdfPermission ist blockiert. Stellen Sie es auf Keiner um alle Aktionen außer dem Öffnen zu blockieren oder um ein bestimmtes Flag wie z. B. Formulare ausfüllen ausschließlich das Ausfüllen von Formularen zuzulassen.REST API Endpunkt
Verfahren: POST
URL: https://api.pdf4me.com/api/v2/Protect
Schicken Content-Type: application/json und ein Genehmigung Kopfzeile mit Ihrem API Schlüssel. Satz asynchron Zu FALSCH für eine synchrone Antwort (HTTP 200 mit der verschlüsselten PDF als rohe Binärbytes) oder WAHR um zu erhalten HTTP 202 plus a Standort Header, den Sie so lange abfragen, bis er den Statuscode 200 mit dem Binärwert zurückgibt. PDFDie
Postman-Anfrage einrichten
| Einstellung | Wert |
|---|---|
| Method | POST |
| URL | https://api.pdf4me.com/api/v2/Protect |
| Headers | Content-Type: application/json |
| Authorization | Basic Auth with your API key, or header Authorization: Basic YOUR_API_KEY |
| Body | raw JSON with docContent, docName, password, pdfPermission, and async fields |
| Response (sync) | When async is false: HTTP 200 with the encrypted PDF as raw binary bytes. Save the response body directly to a .pdf file. |
| Response (async) | When async is true: HTTP 202 with a Location header. GET that URL until you receive 200 plus the binary PDF. Useful for large files or slow networks. |
Parameter
Immer erforderlich: docContent, docName, Passwort, pdfPermission. Der asynchron Das Flag ist optional (Standardwert: FALSCH) und steuert, ob die Antwort sofort oder über eine Abfrage-URL zurückgegeben wird.
| Parameter | Erforderlich | Typ | Was es tut | Beispiel |
|---|---|---|---|---|
docContent | Required | Base64 String | The source PDF file encoded as Base64 (no data: prefix). Read the file as bytes and run it through your language's Base64 encoder. | JVBERi0xLjQK... |
docName | Required | String | Filename of the source PDF including the .pdf extension. Used for tracking and the output filename. | invoice.pdf |
password | Required | String | The password applied to the encrypted PDF. Users must enter this to open the document. | Str0ng-P@ss! |
pdfPermission | Required | Enum | What the user can do once the PDF is unlocked. One of: All, None, Copy, Annotate, Fill Forms, Support Disabilities, Assemble, Digital Print. See the flag reference card grid below. | Fill Forms |
async | Optional | Boolean | Defaults to false. When false the API returns the encrypted PDF immediately as binary bytes (HTTP 200). When true the API returns HTTP 202 with a Location header; poll that URL with GET until you receive 200 with the binary PDF. Use true for large PDFs or batch processing. | false |
Welches pdfPermission-Flag sollte ich auswählen?
Das Passwort und das Berechtigungsflag schützen vor unterschiedlichen Dingen. Das Passwort verhindert das Öffnen des Geräts; das Berechtigungsflag steuert, was nach dem Öffnen geschieht.
| Passwort vs. Berechtigungen | password Feld | pdfPermission Feld |
|---|---|---|
| Schützt vor | Unbefugte Öffnung | Unerwünschte Aktionen nach dem Öffnen |
| Wen es betrifft | Alle ohne Passwort | Alle, die das Dokument geöffnet haben |
| Typische Verwendung | Vertrauliche Zustellung | Verträge ohne Lesezugriff, Probekopien |
| Restriktivster Wert | Ein starkes, einzigartiges Passwort | None (nur geöffnet) |
AlleAlles ist erlaubt.KeinerNur ÖffnungKopieÖffnen und kopieren Sie Text oder BilderKommentierenÖffnen und kommentierenFormulare ausfüllenFormularfelder öffnen und ausfüllenUnterstützung von Menschen mit BehinderungenMit Barrierefreiheitstools öffnenMontierenÄnderungen auf Seitenebene zulässigDigitaldruckNur Druck in niedriger AuflösungBeispiele anfordern
Beispiel A: Nur mit Passwort verschlüsseln (All Berechtigungen)
{
"docContent": "JVBERi0xLjQK...",
"docName": "invoice.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "All",
"async": false
}
Beispiel B: Verschlüsselung mit maximalen Einschränkungen (None)
Blockiert Drucken, Kopieren, Bearbeiten, Kommentieren und Formularausfüllen.
{
"docContent": "JVBERi0xLjQK...",
"docName": "confidential.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "None",
"async": false
}
Beispiel C: Nur Formularausfüllung verschlüsseln und zulassen
Nützlich für vertrauliche Aufnahmeformulare, die vom Empfänger ausgefüllt, aber nicht weitergegeben werden dürfen.
{
"docContent": "JVBERi0xLjQK...",
"docName": "intake-form.pdf",
"password": "Form-2026",
"pdfPermission": "Fill Forms",
"async": true
}
Erfolgreiche Antwort (Synchronisation, async: false)
HTTP 200 mit der verschlüsselten PDF als der Rohantwortkörper (binär) application/pdf). NEIN JSON Wrapping. Speichern Sie die Antwortbytes direkt in einer Datei.
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="protected.pdf"
<binary PDF bytes>
Erfolgreiche Antwort (asynchron, async: true)
HTTP 202 mit einem Location Überschrift. Frage das URL mit GET (Dasselbe Authorization Header) bis Sie erhalten HTTP 200 mit dem Binärsystem PDFDie
HTTP/1.1 202 Accepted
Location: https://api.pdf4me.com/api/v2/JobStatus/<job-id>
Beispiele für Locken
Synchronisierungsmodus (Speichern des Antworttextes direkt in einer Datei):
curl -X POST https://api.pdf4me.com/api/v2/Protect \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-o protected.pdf \
-d '{"docContent":"JVBERi0xLjQK...","docName":"invoice.pdf","password":"Str0ng-P@ss!","pdfPermission":"Fill Forms","async":false}'
Asynchroner Modus (Hinweis) -D headers.txt um die Location Kopfzeile für die Abfrage:
curl -X POST https://api.pdf4me.com/api/v2/Protect \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-D headers.txt \
-d '{"docContent":"...","docName":"invoice.pdf","password":"Str0ng-P@ss!","pdfPermission":"Fill Forms","async":true}'
Was gibt die API zurück?
Das verschlüsselte Dokument selbst. Der Schutz wird angewendet durch AES-Verschlüsselung wie von der PDF-SpezifikationDaher fordert jeder standardkonforme Reader das Passwort an und erzwingt die Berechtigungsprüfung.
| Feld | Typ | Was es enthält |
|---|---|---|
| Response body (HTTP 200) | Binary | The encrypted PDF bytes (Content-Type application/pdf). Write them straight to a new .pdf file; the source file is never modified. |
| Location header (HTTP 202) | String (URL) | Returned when async is true and processing continues in the background. GET this URL with the same Authorization header. |
| Poll response (HTTP 200) | Binary | The finished encrypted PDF, returned once the async job completes. |
| Poll response (HTTP 202) | Empty | Job still processing. Wait and poll the same Location URL again. |
Codebeispiele
Integrationsbeispiele
Gängige REST-IntegrationsmusterTypical ways developers call Protect Document.
- Lesen Sie jede Rechnung sorgfältig durch. PDF aus einem Ordner S3 Bucket oder Datenbank-Warteschlange.
- Base64-kodieren Sie die Bytes und POST zum Schutz mit
pdfPermissioneingestellt aufFormulare ausfüllenDie - Schreibe die Antwortbytes direkt in eine .pdf-Datei (rohe Binärdaten) und lade anschließend die verschlüsselte Datei per E-Mail oder im Objektspeicher hoch.
- Jede Datei wird durchlaufen. Der Endpunkt ist zustandslos und sicher für parallele Aufrufe innerhalb Ihres Ratenlimits.
- POST die Quelle PDF Zu
/api/v2/Protectmit dem Empfängerpasswort und der gewählten Berechtigung. - Nimm die binären Antwortbytes und kodiere sie neu zu Base64und füttern Sie sie als
docContentzum Digitales Schild Endpunkt. - Erhalten Sie ein einzelnes PDF das ist beides AES-verschlüsselt und kryptografisch signiert. Manipulationssicher für rechtliche und Compliance-Anforderungen.
- Generieren Sie für jeden Empfänger ein eindeutiges Passwort (UUID oder abgeleitet von einem gemeinsamen Geheimnis).
- POST zum Schutz mit diesem Passwort und
pdfPermissioneingestellt aufKeinerAlle Kopier- und Druckvorgänge sollen blockiert werden. - E-Mail mit dem verschlüsselten Inhalt PDF und das Passwort über einen separaten Kanal für die Einhaltung der Vorschriften.