Passa al contenuto principale
PDF4me APIIntegrazioniBase di conoscenzaEstensioniTester APIBlog

Documento protetto - Sicurezza dei documenti API

PDF4me Documento protetto consente di aggiungere protezione tramite password e restrizioni di sicurezza ai documenti Word con controlli di sicurezza completi e restrizioni di modifica. Questo API Il servizio elabora i file Word e applica la protezione tramite password, le restrizioni di modifica dei documenti, la protezione in sola lettura, l'accesso solo ai commenti, la modifica dei campi del modulo e il monitoraggio delle revisioni. API riceve il contenuto del documento Word tramite REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Grazie al controllo completo sui livelli di sicurezza e sui requisiti di password, questa soluzione è ideale per documenti riservati, modifiche collaborative e flussi di lavoro di controllo degli accessi ai documenti.

Articoli correlati del blog
Non ci sono ancora post sul blog dedicati a questa funzionalità — in arrivo a breve.
Nel frattempo, dai un'occhiata al blog di PDF4me per trovare tutorial e procedure operative su tutte le piattaforme.
Visita il blog →

Autenticazione del tuo API Richiesta​

Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.

Get your api Key

Caratteristiche principali​

  • Protezione tramite passwordAggiungere requisiti di password per aprire i documenti
  • Protezione dei documentiLimita le funzionalità di modifica con vari tipi di protezione
  • Sicurezza di sola lettura: Rendere i documenti di sola lettura per impedire modifiche non autorizzate
  • Accesso solo per i commenti: Consenti solo l'aggiunta o la modifica dei commenti
  • Modifica dei campi del moduloLimita la modifica ai soli campi del modulo
  • Tracciamento delle revisioni: Consenti solo modifiche e revisioni tracciate
  • Sicurezza combinata: Applicare sia la protezione tramite password che le restrizioni di modifica
  • Controllo degli accessi flessibileDiversi livelli di sicurezza per diversi casi d'uso

REST API Punto finale​

IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di sicurezza dei documenti vengono eseguite tramite un unico endpoint:

  • Metodo: POST
  • Punto finale: office/ApiV2Word/ApplySecurity

REST API Parametri​

Elenco completo dei parametri per il documento sicuro REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.

Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori. I parametri relativi alla password sono obbligatori quando le relative opzioni di sicurezza sono abilitate.

Parametri richiesti​

ParametroTipoDescrizioneEsempio
documento*ObjectRiferimento al documento. Deve contenere Nome string): Nome del file Word con estensione .docx{ "Name": "document.docx" }
docContent*Base64Il contenuto del documento Word codificato in Base64Le impostazioni di sicurezza sono applicate a questo documento. Deve essere un documento Word valido (formati .docx, .doc).base64EncodedDocumentContent

Parametri opzionali (Impostazioni di sicurezza)​

ParametroTipoDescrizioneEsempio
secureOnOpenStringAttiva la protezione tramite password per aprire il documento. "yes" = Richiede password per l'apertura, "no" = Nessuna password richiesta per aprire (impostazione predefinita). Richiede secureOnOpenPassword quando abilitato"yes"
secureOnOpenPasswordStringPassword necessaria per aprire il documento. Obbligatorio quando secureOnOpen È "yes"La password deve essere sicura (almeno 8 caratteri). È importante distinguere tra maiuscole e minuscole."SecurePass123!"
opzioni di sicurezzaObjectOpzioni di protezione del documento. Proprietà: Tipo di protezione string: NoProtection, ReadOnly, AllowComments, AllowFormFields, AllowRevisions), password di protezione string). Obbligatorio quando protectionType non è "NoProtection"{ "protectionType": "ReadOnly", "protectionPassword": "EditPass456!" }

Opzioni relative al tipo di protezione​

IL API offre diversi tipi di protezione per le restrizioni di modifica dei documenti:

Tipo di protezioneDescrizioneCaso d'uso
NoProtectionNessuna restrizione di modifica (impostazione predefinita)Documenti che possono essere modificati liberamente
ReadOnlyIl documento non può essere modificato, solo visualizzato.Documenti finali, rapporti pubblicati
AllowCommentsÈ possibile aggiungere/modificare solo i commenti.Flussi di lavoro per la revisione dei documenti
AllowFormFieldsÈ possibile modificare solo i campi del modulo.Moduli compilabili, sondaggi
AllowRevisionsSono consentite solo le modifiche/revisioni tracciate.Modifica collaborativa con tracciamento delle modifiche

Configurazione di sicurezza​

Protezione con password (Open Password)​

  • Scopo: Richiede una password per aprire il documento
  • Quando utilizzareDocumenti riservati, informazioni sensibili
  • Requisito: secureOnOpenPassword deve essere fornito quando secureOnOpen È "yes"
  • Forza: Si consigliano almeno 8 caratteri, inclusi caratteri alfanumerici e speciali

Protezione del documento (restrizioni di modifica)​

  • ScopoLimita le funzionalità di modifica pur consentendo la visualizzazione del documento.
  • Quando utilizzare: Modifica collaborativa, distribuzione di moduli, flussi di lavoro di revisione
  • Requisito: securityOptions.protectionPassword deve essere fornito quando securityOptions.protectionType non è "NoProtection"
  • FlessibilitàPuò essere combinato con password aperta per una sicurezza a doppio livello.

Produzione​

IL PDF4me Documento protetto REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il documento Word come un Base64-stringa codificata in JSON formato, non come dati binari.

Elaborazione sincrona (impostazione predefinita)

IL API elabora la richiesta e restituisce:

Codice di stato: 200 OK

Tipo di contenuto: application/json

Corpo della risposta:

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

Campi di risposta:

  • documento string): Il documento Word con le impostazioni di sicurezza applicate, codificato come Base64 corda
  • Nome file string): Il nome del file Word di output
  • successo boolean): Indica se la richiesta è andata a buon fine
  • messaggio di errore string o null): Dettagli dell'errore quando il successo è falso

Come si usa:

  1. Estrarre il document campo dal JSON risposta (Base64)
  2. decodificare il Base64 stringa per ottenere i dati binari del documento Word
  3. Salva o elabora il file Word secondo necessità.
  4. Il documento richiederà una o più password all'apertura in Word, in base alle impostazioni di sicurezza.

Esempio (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

Esempio di richiesta​

Intestazione​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota:

  • Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
  • IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
  • Esempio: se il tuo API la chiave è abc123, codificalo in Base64 e utilizzare Authorization: Basic YWJjMTIz

Carico utile​

Esempio base (solo protezione con password):

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

Esempio avanzato (password + protezione di sola lettura):

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

Esempio di protezione solo per i commenti:

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

Esempio di protezione dei campi del modulo:

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

Esempi di codice​

IL PDF4me Documento protetto REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:

C# CSharp) Campione

Completo C# Implementazione per la protezione dei documenti Word:

Casi d'uso e applicazioni industriali​

Casi d'uso per servizi legali e professionali

  • Documenti riservati del cliente: Applicare la protezione tramite password ai documenti legali sensibili
  • Sicurezza contrattualeContratti sicuri con protezione di sola lettura per la revisione da parte del cliente
  • Distribuzione in forma legale: Applicare la protezione dei campi modulo ai moduli legali
  • Revisione del documento: Utilizzare la protezione "solo commenti" per la revisione dei documenti legali

Richiedi assistenza​

Get Your API KeyAPI SamplesGetting Started