Crittografare un documento PDF API
PDF4me Proteggi il documento è un endpoint REST che protegge con password un PDF e limita ciò che i destinatari possono fare con esso. Invia il file come Base64 a /api/v2/Protect con una password e un flag di autorizzazione, e la risposta è un nuovo PDF crittografato con AES. Stampa, copia, modifica e compilazione del modulo sono consentite solo se lo si autorizza.
Cosa fa questo endpoint
PDF4me Proteggi il documento crittografa un PDF con una password e imposta i flag di autorizzazione in un singolo REST chiamata. Invia il PDF COME Base64, scegli la password e quali azioni sono consentite (stampa, copia, annotazione, compilazione moduli) e ricevi un nuovo AES-crittografato PDF nella risposta. La crittografia applicata è AES-128 o AES-256 secondo il PDF specifica, adatta per GDPR, HIPAAe altri flussi di lavoro orientati alla conformità.
Autenticazione del tuo API Richiesta
Ogni PDF4me REST API la chiamata deve includere il tuo API chiave nel Authorization Intestazione. Crea o seleziona una chiave dalla dashboard per sviluppatori e mantienila lato server. Non esporla mai nel codice del browser.
Informazioni importanti da non perdere
password apertura del documento dei cancelli del campo. Il pdfPermesso enum controlla cosa possono fare gli utenti una volta aperto il documento. Usali entrambi insieme per distribuire un PDF che richiede una password E disabilita la stampa o la copia.pdfPermesso è bloccato. Impostalo su Nessuno per bloccare ogni azione tranne l'apertura, o a un flag specifico come Compila i moduli consentire solo la compilazione dei moduli e nient'altro.REST API endpoint
Metodo: INVIARE
URL: https://api.pdf4me.com/api/v2/Protect
Inviare Content-Type: application/json e un Autorizzazione intestazione con il tuo API chiave. Imposta asincrono A falso per una risposta sincrona (HTTP 200 con il crittografato PDF come byte binari grezzi), oppure VERO ricevere HTTP 202 più un Posizione intestazione che viene interrogata finché non restituisce 200 con il binario PDF.
configurazione della richiesta Postman
| Collocamento | Valore |
|---|---|
| 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. |
Parametri
Sempre richiesto: docContent, docName, password, pdfPermesso. IL asincrono il flag è facoltativo (predefinito a falso) e controlla se la risposta viene restituita immediatamente o tramite un URL di polling.
| Parametro | Necessario | Tipo | Cosa fa | Esempio |
|---|---|---|---|---|
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 |
Quale flag pdfPermission devo scegliere?
La password e il flag di autorizzazione proteggono da cose diverse. La password impedisce l'apertura; il flag di autorizzazione controlla ciò che accade dopo l'apertura.
| Password vs. autorizzazioni | password campo | pdfPermission campo |
|---|---|---|
| Protegge da | Apertura non autorizzata | Azioni indesiderate dopo l'apertura |
| Chi ne è interessato | Chiunque senza la password | Chiunque abbia aperto il documento |
| Uso tipico | Consegna riservata | Contratti di sola lettura, bozze |
| Valore più restrittivo | Una password forte e univoca | None (solo aperto) |
TuttoTutto è permessoNessunoSolo aperturaCopiaApri e copia testo o immaginiAnnotareApri e annotaCompila i moduliApri e compila i campi del moduloSostegno alle persone con disabilitàApri con gli strumenti di accessibilitàAssemblareModifiche a livello di pagina consentiteStampa digitaleStampa a bassa risoluzione soltantoEsempi di richieste
Esempio A: Crittografare solo con password (All permessi)
{
"docContent": "JVBERi0xLjQK...",
"docName": "invoice.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "All",
"async": false
}
Esempio B: Crittografare con restrizioni massime (None)
Consente di stampare, copiare, modificare, annotare e compilare moduli.
{
"docContent": "JVBERi0xLjQK...",
"docName": "confidential.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "None",
"async": false
}
Esempio C: Crittografare e consentire solo la compilazione del modulo
Utile per moduli di ammissione riservati che il destinatario deve compilare ma non ridistribuire.
{
"docContent": "JVBERi0xLjQK...",
"docName": "intake-form.pdf",
"password": "Form-2026",
"pdfPermission": "Fill Forms",
"async": true
}
Risposta positiva (sincronizzazione, async: false)
HTTP 200 con il crittografato PDF come corpo della risposta grezza (binario) application/pdf). NO JSON Incapsulamento. Salva i byte della risposta direttamente in un file.
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="protected.pdf"
<binary PDF bytes>
Risposta positiva (asincrona, async: true)
HTTP 202 con un Location intestazione. Sondaggio su URL con GET (Stesso Authorization intestazione) fino a quando non ricevi HTTP 200 con il binario PDF.
HTTP/1.1 202 Accepted
Location: https://api.pdf4me.com/api/v2/JobStatus/<job-id>
esempi di ricci
Modalità di sincronizzazione (salva il corpo della risposta direttamente in un file):
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}'
Modalità asincrona (nota -D headers.txt per catturare il Location intestazione per il sondaggio):
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}'
Quali informazioni restituisce l'API?
Il documento crittografato stesso. La protezione viene applicata con Crittografia AES come definito dal Specifiche PDFPertanto, qualsiasi lettore conforme agli standard richiede la password e applica il flag di autorizzazione.
| Campo | Tipo | Cosa contiene |
|---|---|---|
| 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. |
Esempi di codice
Esempi di integrazione
Modelli comuni di integrazione RESTTypical ways developers call Protect Document.
- Leggere attentamente ogni fattura PDF da una cartella, S3 secchio o coda del database.
- Base64-codifica i byte e POST per proteggere con
pdfPermessoimpostato suCompila i moduli. - Scrivi i byte della risposta direttamente in un file .pdf (in formato binario grezzo), quindi carica il file crittografato tramite e-mail o su un archivio di oggetti.
- Esegui un ciclo su ogni file. L'endpoint è stateless e sicuro per chiamate parallele entro il limite di frequenza impostato.
- POST la fonte PDF A
/api/v2/Protezionecon la password del destinatario e le autorizzazioni selezionate. - Prendi i byte della risposta binaria, ricodificali in Base64e nutrirli come
docContentper il Segnaletica digitale punto finale. - Ricevi un singolo PDF che è entrambe le cose AES-Crittografato e firmato crittograficamente. Antimanomissione per casi d'uso legali e di conformità.
- Genera una password univoca per ogni destinatario (UUID o derivato da un segreto condiviso).
- POST per proteggere con quella password e
pdfPermessoimpostato suNessunoper bloccare ogni copia e stampa. - Inviare via e-mail il codice crittografato PDF e la password tramite un canale separato per le tracce di controllo di conformità.