Dokument schützen
Sicherheit → Dokument schützen
Der Dokument schützen API Fügt Passwortschutz und Berechtigungen zu einem hinzu PDFSie senden die PDF als Base64 (docContent), docName, Passwort, pdfPermission (z. B. Alle) und optional asynchron. Der API gibt ein passwortgeschütztes PDF mit den angegebenen Berechtigungen. Verwenden Sie den unten stehenden Tester, um es auszuprobieren; weitere Details finden Sie in den folgenden Abschnitten.
Probieren Sie die Funktion „Dokument schützen“ aus. API
:::Hinweis Kurzübersicht
Kurzübersicht
Endpunkt: POST /api/v2/Protect · Erforderlich: API-Schlüssel, Dokumentinhalt, Dokumentname, Passwort, PDF-Berechtigung
:::
Nutzen Sie das untenstehende Formular, um Ihre Anfrage zu senden API Schlüssel, PDF (Base64), Passwort und Berechtigungen. Die Antwort ist das passwortgeschützte PDFKein Code erforderlich, einfach die Felder ausfüllen und klicken. Anfrage senden.
Überblick, Parameter und Anwendungsfälle
- Overview
- Parameters
- Use cases
Was ist „Dokument schützen“?
Dieser Endpunkt schützt einen PDF mit einem Passwort und legt Dokumentberechtigungen fest. Sie stellen das Passwort bereit. PDF (Base64), docName, Passwort (Benutzer-/Besitzerpasswort) und pdfPermission (z. B. Alle). API gibt ein zurück PDF Diese Funktion erfordert ein Passwort zum Öffnen und setzt die gewählten Berechtigungen durch (z. B. Drucken, Kopieren). Verwenden Sie sie, um den Zugriff oder die Bearbeitung einzuschränken.
Hauptmerkmale
- Passwortschutz: Passwort ist erforderlich, um die PDFDer Inhalt ist verschlüsselt.
- Berechtigungen: pdfPermission Steuert, was Benutzer tun dürfen (z. B. alles oder eingeschränkt).
- Async: Verwenden asynchron für große PDFsDie
- Einzelanfrage: Schicken docContent (Base64), docName, Passwort, pdfPermission; keine zusätzlichen Schritte.
:::Tipp Ideal für Verwenden Sie diese Option, wenn Sie einschränken müssen, wer eine Datei öffnen oder bearbeiten darf. PDFUm den Schutz aufzuheben, verwenden Sie Entsperren PDF mit dem richtigen Passwort.
:::
API Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| API-Schlüssel | Zeichenkette | Ja | Dein PDF4me API Schlüssel, Base64 kodiert. Holen Sie es sich von der ArmaturenbrettDie |
| docContent | base64 | Ja | PDF Dateiinhalt (Base64). |
| docName | Zeichenkette | Ja | Ausgabe PDF Dateiname (z. B. output.pdf). |
| Passwort | Zeichenkette | Ja | Passwort für den geschützten Bereich PDFDie |
| pdfPermission | Zeichenkette | Ja | PDF Berechtigungen (z.B. Alle). |
| asynchron | boolescher Wert | NEIN | Asynchrone Verarbeitung aktivieren. |
Wann sollte man „Dokument schützen“ verwenden?
- Vertrauliche DokumenteFügen Sie ein Passwort hinzu, damit nur autorisierte Benutzer die Datei öffnen können. PDFDie
- Bearbeitung einschränken: Berechtigungen festlegen, um Drucken, Kopieren oder Bearbeiten zu verhindern.
- Verteilung: Schützen Sie sensible Bereiche PDFs vor dem Teilen oder Versenden per E-Mail.
- Einhaltung: Zugriffskontrolle für regulierte Dokumente durchsetzen.
Für Anfrage-/Antwortschemata und Codebeispiele siehe Dokument schützen im PDF4me API Dokumente.
Voraussetzungen
Bevor Sie diesen Endpunkt verwenden, stellen Sie sicher, dass Sie Folgendes haben:
- Ein gültiger PDF4me API Schlüssel (Hol dir deins API Schlüssel)
- A PDF Datei in Base64 Format
Antwortformat
Der API gibt ein passwortgeschütztes PDF Datei mit den angegebenen Berechtigungen.