Chiffrer un document PDF API
PDF4me Protéger le document est un point de terminaison REST qui protège un PDF par mot de passe et restreint les actions que les destinataires peuvent effectuer avec ce fichier. Envoyez le fichier au format Base64 à l'adresse POST. /api/v2/Protect Un mot de passe et un indicateur d'autorisation sont requis, et la réponse est un nouveau PDF chiffré AES. L'impression, la copie, la modification et le remplissage du formulaire ne sont autorisés que si vous y consentez.
Que fait ce point de terminaison ?
PDF4me Document de protection chiffre un PDF avec un mot de passe et définit les indicateurs d'autorisation en une seule REST Appelez. Envoyez l'appel. PDF comme Base64Choisissez le mot de passe et les actions autorisées (impression, copie, annotation, remplissage de formulaires), puis recevez un nouveau AES-crypté PDF dans la réponse. Le chiffrement appliqué est AES-128 ou AES-256 par rapport au PDF spécifications, adaptées à GDPR, HIPAAet d'autres flux de travail axés sur la conformité.
Authentification de votre API Demande
Chaque PDF4me REST API L'appel doit inclure votre API clé dans le Authorization En-tête. Créez ou sélectionnez une clé depuis le tableau de bord développeur et conservez-la côté serveur. Ne l'exposez jamais dans le code du navigateur.
Informations importantes à ne pas manquer
mot de passe Ouverture du document des portes de champ. pdfPermission L'énumération contrôle les actions possibles pour les utilisateurs une fois le document ouvert. Utilisez les deux conjointement pour distribuer un PDF qui exige un mot de passe ET désactive l'impression ou la copie.pdfPermission est bloqué. Configurez-le sur Aucun bloquer toute action sauf l'ouverture, ou un indicateur spécifique tel que Remplir les formulaires autoriser uniquement le remplissage de formulaires et rien d'autre.REST API point de terminaison
Méthode: POSTE
URL : https://api.pdf4me.com/api/v2/Protect
Envoyer Type de contenu : application/json et un Autorisation en-tête avec votre API clé. Définir asynchrone à FAUX pour une réponse synchrone (HTTP 200 avec le chiffrement PDF sous forme d'octets binaires bruts), ou vrai recevoir HTTP 202 plus a Emplacement en-tête que vous interrogez jusqu'à ce qu'il renvoie 200 avec le binaire PDF.
Configuration de la requête Postman
| Paramètre | Valeur |
|---|---|
| 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. |
Paramètres
Toujours requis : docContent, Nom du document, mot de passe, pdfPermission. Le asynchrone L'indicateur est facultatif (par défaut : FAUX) et détermine si la réponse est renvoyée immédiatement ou via une URL d'interrogation.
| Paramètre | Requis | Taper | Ce que cela fait | Exemple |
|---|---|---|---|---|
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 |
Quel indicateur pdfPermission dois-je choisir ?
Le mot de passe et l'indicateur d'autorisation protègent contre des actions différentes. Le mot de passe contrôle l'ouverture ; l'indicateur d'autorisation contrôle ce qui se passe une fois l'ouverture effectuée.
| Mot de passe vs permissions | password champ | pdfPermission champ |
|---|---|---|
| Protège contre | Ouverture non autorisée | Actions indésirables après l'ouverture |
| Qui cela affecte-t-il ? | Tous ceux qui n'ont pas le mot de passe | Tous ceux qui ont ouvert le document |
| Utilisation typique | Livraison confidentielle | Contrats en lecture seule, exemplaires de preuve |
| Valeur la plus restrictive | Un mot de passe fort et unique | None (Ouvert seulement) |
TousTout est permisAucunOuverture uniquementCopieOuvrir et copier le texte ou les imagesAnnoterOuvrir et annoterRemplir les formulairesOuvrir et remplir les champs du formulaireSoutien aux personnes handicapéesOuvrir avec les outils d'accessibilitéAssemblerLes modifications au niveau de la page sont autorisées.Impression numériqueImpression basse résolution uniquementExemples de demandes
Exemple A : Chiffrer avec un mot de passe uniquement (All autorisations)
{
"docContent": "JVBERi0xLjQK...",
"docName": "invoice.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "All",
"async": false
}
Exemple B : Chiffrer avec des restrictions maximales (None)
Blocs permettant l'impression, la copie, l'édition, l'annotation et le remplissage de formulaires.
{
"docContent": "JVBERi0xLjQK...",
"docName": "confidential.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "None",
"async": false
}
Exemple C : Chiffrer et autoriser uniquement le remplissage du formulaire
Utile pour les formulaires d'admission confidentiels que le destinataire doit remplir mais ne pas redistribuer.
{
"docContent": "JVBERi0xLjQK...",
"docName": "intake-form.pdf",
"password": "Form-2026",
"pdfPermission": "Fill Forms",
"async": true
}
Réponse réussie (synchronisation, async: false)
HTTP 200 avec le chiffrement PDF comme le corps de réponse brut (binaire) application/pdf). Non JSON Encapsulation. Enregistrez directement les octets de réponse dans un fichier.
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="protected.pdf"
<binary PDF bytes>
Réponse réussie (asynchrone, async: true)
HTTP 202 avec un Location en-tête. Sondez cela URL avec GET (même Authorization en-tête) jusqu'à ce que vous receviez HTTP 200 avec le binaire PDF.
HTTP/1.1 202 Accepted
Location: https://api.pdf4me.com/api/v2/JobStatus/<job-id>
Exemples de curl
Mode de synchronisation (enregistrement direct du corps de la réponse dans un fichier) :
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}'
Mode asynchrone (note) -D headers.txt pour capturer le Location en-tête pour le sondage) :
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}'
Que renvoie l'API ?
Le document chiffré lui-même. La protection est appliquée avec Chiffrement AES tel que défini par le Spécifications PDF, donc tout lecteur conforme aux normes demande le mot de passe et applique l'indicateur d'autorisation.
| Champ | Taper | Ce qu'il contient |
|---|---|---|
| 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. |
Exemples de code
Exemples d'intégration
Modèles d'intégration REST courantsTypical ways developers call Protect Document.
- Lisez chaque facture PDF à partir d'un dossier, S3 seau, ou file d'attente de base de données.
- Base64-encoder les octets et POST Protéger avec
pdfPermissiondéfini àRemplir les formulaires. - Écrivez directement les octets de réponse dans un fichier .pdf (binaire brut), puis téléchargez le fichier chiffré par e-mail ou vers un système de stockage d'objets.
- Parcourez chaque fichier. Le point de terminaison est sans état et sécurisé pour les appels parallèles dans les limites de votre débit.
- POST la source PDF à
/api/v2/Protectavec le mot de passe du destinataire et l'autorisation choisie. - Prenez les octets de réponse binaire, réencodez-les en Base64, et les nourrir comme
docContentau Panneau numérique point final. - Recevez un seul PDF c'est à la fois AES- Chiffré et signé cryptographiquement. Inviolable pour les cas d'utilisation légaux et de conformité.
- Générer un mot de passe unique par destinataire (UUID ou dérivé d'un secret partagé).
- POST Pour protéger avec ce mot de passe et
pdfPermissiondéfini àAucunbloquer toute copie et impression. - Envoyez par e-mail le contenu crypté PDF et le mot de passe via un canal distinct pour les pistes d'audit de conformité.