Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

Sicheres Dokument – Dokumentensicherheit API

PDF4me Sicheres Dokument Ermöglicht das Hinzufügen von Passwortschutz und Sicherheitsbeschränkungen zu Word-Dokumenten mit umfassenden Sicherheitskontrollen und Bearbeitungsbeschränkungen. API Der Dienst verarbeitet Word-Dateien und wendet Passwortschutz, Bearbeitungsbeschränkungen, Schreibschutz, Kommentarzugriff, Formularfeldbearbeitung und Revisionsverfolgung an. API empfängt Word-Dokumentinhalte über REST API Anrufe, die genutzt werden Base64 Verschlüsselung für sichere Übertragung. Dank vollständiger Kontrolle über Sicherheitsstufen und Passwortanforderungen eignet sich diese Lösung ideal für vertrauliche Dokumente, kollaboratives Bearbeiten und Workflows zur Dokumentenzugriffskontrolle.

Verwandte Blog-Beiträge
Zu dieser Funktion gibt es noch keinen Blogbeitrag – folgt in Kürze.
Schauen Sie sich in der Zwischenzeit im PDF4me-Blog Tutorials und Arbeitsabläufe für alle Plattformen an.
Besuchen Sie den Blog →

Authentifizierung Ihres API Anfrage​

Um auf die PDF4me REST APIJede Anfrage muss die entsprechenden Authentifizierungsdaten enthalten. Die Authentifizierung gewährleistet eine sichere Kommunikation und bestätigt Ihre Identität als autorisierter Benutzer des Systems. REST APIDie

Get your api Key

Hauptmerkmale​

  • Passwortschutz: Passwortanforderungen zum Öffnen von Dokumenten hinzufügen
  • Dokumentenschutz: Bearbeitungsmöglichkeiten durch verschiedene Schutzarten einschränken
  • Nur-Lese-Sicherheit: Dokumente schreibgeschützt machen, um unbefugte Bearbeitungen zu verhindern
  • Nur-Kommentar-Zugriff: Nur das Hinzufügen oder Ändern von Kommentaren zulassen
  • Formularfeldbearbeitung: Bearbeitung nur auf Formularfelder beschränken
  • Revisionsverfolgung: Nur nachverfolgte Änderungen und Revisionen zulassen
  • Kombinierte Sicherheit: Sowohl Passwortschutz als auch Bearbeitungsbeschränkungen anwenden
  • Flexible ZugangskontrolleUnterschiedliche Sicherheitsstufen für unterschiedliche Anwendungsfälle

REST API Endpunkt​

Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Dokumentensicherheitsoperationen werden über einen einzigen Endpunkt durchgeführt:

  • Verfahren: POST
  • Endpunkt: office/ApiV2Word/ApplySecurity

REST API Parameter​

Vollständige Liste der Parameter für das sichere Dokument REST APIDie Parameter sind zur besseren Verständlichkeit und Implementierung nach Kategorien geordnet.

Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind Pflichtfelder. Passwortparameter sind erforderlich, wenn die entsprechenden Sicherheitsoptionen aktiviert sind.

Erforderliche Parameter​

ParameterTypBeschreibungBeispiel
dokumentieren*ObjectDokumentenreferenz. Muss enthalten Name (string): Word-Dateiname mit der Erweiterung .docx{ "Name": "document.docx" }
docContent*Base64Word-Dokumentinhalt kodiert in Base64Für dieses Dokument gelten Sicherheitseinstellungen. Es muss sich um ein gültiges Word-Dokument handeln (Formate: .docx, .doc).base64EncodedDocumentContent

Optionale Parameter (Sicherheitseinstellungen)​

ParameterTypBeschreibungBeispiel
secureOnOpenStringAktivieren Sie den Passwortschutz zum Öffnen des Dokuments. "yes" = Zum Öffnen ist ein Passwort erforderlich, "no" = Kein Passwort zum Öffnen erforderlich (Standard). Erforderlich secureOnOpenPassword wenn aktiviert"yes"
secureOnOpenPasswordStringZum Öffnen des Dokuments ist ein Passwort erforderlich. Erforderlich, wenn secureOnOpen Ist "yes"Das Passwort sollte sicher sein (mindestens 8 Zeichen). Groß- und Kleinschreibung beachten."SecurePass123!"
SicherheitsoptionenObjectOptionen zum Dokumentenschutz. Eigenschaften: Schutzart (string: NoProtection, ReadOnly, AllowComments, AllowFormFields, AllowRevisions), Schutzpasswort (string) Erforderlich, wenn protectionType nicht "NoProtection" ist.{ "protectionType": "ReadOnly", "protectionPassword": "EditPass456!" }

Optionen für Schutzarten​

Der API bietet verschiedene Schutzarten für Einschränkungen bei der Dokumentenbearbeitung:

SchutzartBeschreibungAnwendungsfall
NoProtectionKeine Bearbeitungseinschränkungen (Standardeinstellung)Dokumente, die frei bearbeitet werden können
ReadOnlyDas Dokument kann nicht bearbeitet, sondern nur angezeigt werden.Abschlussdokumente, veröffentlichte Berichte
AllowCommentsEs können nur Kommentare hinzugefügt/geändert werden.Arbeitsabläufe zur Dokumentenprüfung
AllowFormFieldsEs können nur Formularfelder bearbeitet werden.Ausfüllbare Formulare, Umfragen
AllowRevisionsNur nachverfolgte Änderungen/Revisionen zulässigGemeinsames Bearbeiten mit Änderungsverfolgung

Sicherheitskonfiguration​

Passwortschutz (Offenes Passwort)​

  • ZweckZum Öffnen des Dokuments ist ein Passwort erforderlich.
  • Wann verwenden?Vertrauliche Dokumente, sensible Informationen
  • Erfordernis: secureOnOpenPassword muss bereitgestellt werden, wenn secureOnOpen Ist "yes"
  • StärkeEmpfohlen werden mindestens 8 Zeichen inklusive alphanumerischer und Sonderzeichen.

Dokumentenschutz (Bearbeitungsbeschränkungen)​

  • Zweck: Schränkt die Bearbeitungsmöglichkeiten ein, ermöglicht aber die Dokumentenansicht.
  • Wann verwenden?Gemeinsame Bearbeitung, Formularverteilung, Prüfprozesse
  • Erfordernis: securityOptions.protectionPassword muss bereitgestellt werden, wenn securityOptions.protectionType ist nicht "NoProtection"
  • FlexibilitätKann mit einem offenen Passwort für zweistufige Sicherheit kombiniert werden.

Ausgabe​

Der PDF4me Sicheres Dokument REST API Die Antwort hängt vom Verarbeitungsmodus ab. API gibt das Word-Dokument als Base64-kodierte Zeichenkette in JSON Format, nicht als Binärdaten.

Synchrone Verarbeitung (Standard)

Der API verarbeitet die Anfrage und gibt Folgendes zurück:

Statuscode: 200 OK

Inhaltstyp: application/json

Antworttext:

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

Antwortfelder:

  • dokumentieren (string): Das Word-Dokument mit angewendeten Sicherheitseinstellungen, kodiert als Base64 Zeichenkette
  • Dateiname (string): Der Name der ausgegebenen Word-Datei
  • Erfolg (boolean): Gibt an, ob die Anfrage erfolgreich war.
  • Fehlermeldung (string oder null): Fehlerdetails, wenn Erfolg nicht gegeben ist

Anwendungshinweise:

  1. Extrahieren Sie die document Feld vom JSON Antwort (Base64)
  2. Entschlüsseln Sie die Base64 Zeichenkette zum Abrufen der binären Word-Dokumentdaten
  3. Speichern oder bearbeiten Sie die Word-Datei nach Bedarf.
  4. Das Dokument erfordert aufgrund der Sicherheitseinstellungen beim Öffnen in Word ein oder mehrere Passwörter.

Beispiel (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes - document is password protected

Beispielanfrage​

Kopfzeile​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Notiz:

  • Hol dir deins API Schlüssel vom PDF4me Armaturenbrett
  • Der API Der Schlüssel muss sein Base64 kodiert und mit "Basic" präfixiert in der Authorization Überschrift
  • Beispiel: Wenn Ihr API Schlüssel ist abc123, kodieren Sie es zu Base64 und verwenden Authorization: Basic YWJjMTIz

Nutzlast​

Einfaches Beispiel (nur Passwortschutz):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!"
}

Erweitertes Beispiel (Passwort + Schreibschutz):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!",
 "securityOptions": {
 "protectionType": "ReadOnly",
 "protectionPassword": "EditPass456!"
 }
}

Beispiel für den Kommentarschutz:

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowComments",
 "protectionPassword": "ReviewPass789!"
 }
}

Beispiel für den Schutz von Formularfeldern:

{
 "document": { "Name": "form.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowFormFields",
 "protectionPassword": "FormPass2024!"
 }
}

Codebeispiele​

Der PDF4me Sicheres Dokument REST API Es werden Codebeispiele in verschiedenen Programmiersprachen bereitgestellt. Wählen Sie die Sprache, die am besten zu Ihrer Entwicklungsumgebung passt:

C# (CSharp) Probe

Vollständig C# Implementierung zur Sicherung von Word-Dokumenten:

Branchenspezifische Anwendungsfälle und Anwendungen​

Anwendungsfälle für Rechts- und Beratungsdienstleistungen

  • Vertrauliche Kundendokumente: Sensible juristische Dokumente mit einem Passwort schützen
  • VertragssicherheitSichere Verträge mit Leseschutz für die Kundenprüfung
  • Verteilung von Rechtsformularen: Formularfeldschutz auf Rechtsformulare anwenden
  • Dokumentenprüfung: Verwenden Sie den Kommentarschutz für die Überprüfung von Rechtsdokumenten

Hilfe erhalten​

Get Your API KeyAPI SamplesGetting Started