Aller au contenu principal
API PDF4meIntégrationsBase de connaissancesExtensionsTesteur d'APIBlog

Document sécurisé - Sécurité des documents API

PDF4me Document sécurisé vous permet d'ajouter une protection par mot de passe et des restrictions de sécurité aux documents Word grâce à des contrôles de sécurité complets et des restrictions d'édition. API Ce service traite les fichiers Word et applique la protection par mot de passe à l'ouverture, les restrictions de modification des documents, la protection en lecture seule, l'accès en commentaire uniquement, la modification des champs de formulaire et le suivi des révisions. API reçoit le contenu des documents Word via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Grâce à un contrôle total des niveaux de sécurité et des exigences en matière de mots de passe, cette solution est idéale pour les documents confidentiels, l'édition collaborative et les flux de travail de contrôle d'accès aux documents.

Articles de blog connexes
Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.
En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.
Consultez le blog →

Authentification de votre API Demande​

Pour accéder au PDF4me REST APIChaque requête doit inclure des informations d'authentification valides. L'authentification garantit la sécurité des communications et confirme votre identité en tant qu'utilisateur autorisé. REST API.

Get your api Key

Caractéristiques principales​

  • Protection par mot de passeAjouter des exigences de mot de passe pour ouvrir les documents
  • Protection des documentsLimiter les capacités de modification à l'aide de différents types de protection
  • Sécurité en lecture seuleRendez les documents en lecture seule pour empêcher toute modification non autorisée.
  • Accès en mode commentaires uniquementAutoriser uniquement l'ajout ou la modification de commentaires
  • Modification des champs de formulaireLimiter la modification aux seuls champs du formulaire
  • Suivi des révisionsAutoriser uniquement les modifications et révisions suivies
  • Sécurité combinéeAppliquer à la fois la protection par mot de passe et les restrictions de modification
  • Contrôle d'accès flexibleDifférents niveaux de sécurité pour différents cas d'utilisation

REST API Point de terminaison​

Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes les opérations de sécurité des documents sont effectuées via un point de terminaison unique :

  • Méthode: POST
  • Point final : office/ApiV2Word/ApplySecurity

REST API Paramètres​

Liste complète des paramètres du document sécurisé REST APILes paramètres sont organisés par catégorie pour une meilleure compréhension et une mise en œuvre plus aisée.

Important: Les paramètres marqués d'un astérisque (*) sont obligatoires. Les paramètres de mot de passe sont obligatoires lorsque les options de sécurité correspondantes sont activées.

Paramètres requis​

ParamètreTaperDescriptionExemple
document*ObjectRéférence du document. Doit contenir Nom (string): Nom de fichier Word avec l'extension .docx{ "Name": "document.docx" }
docContent*Base64Contenu du document Word encodé en Base64Des paramètres de sécurité sont appliqués à ce document. Doit être un document Word valide (formats .docx ou .doc).base64EncodedDocumentContent

Paramètres optionnels (paramètres de sécurité)​

ParamètreTaperDescriptionExemple
sécuriséOnOpenStringActivez la protection par mot de passe pour ouvrir le document. "yes" = Nécessite un mot de passe pour ouvrir, "no" Aucun mot de passe requis pour ouvrir (par défaut). secureOnOpenPassword lorsqu'il est activé"yes"
secureOnOpenPasswordStringMot de passe requis pour ouvrir le document. Requis lorsque secureOnOpen est "yes"Le mot de passe doit être fort (8 caractères minimum) et sensible à la casse."SecurePass123!"
options de sécuritéObjectOptions de protection des documents. Propriétés : type de protection (string: NoProtection, ReadOnly, AllowComments, AllowFormFields, AllowRevisions), protectionMot de passe (string). Requis lorsque protectionType n'est pas « NoProtection »{ "protectionType": "ReadOnly", "protectionPassword": "EditPass456!" }

Options de type de protection​

Le API propose différents types de protection pour les restrictions de modification de documents :

Type de protectionDescriptionCas d'utilisation
NoProtectionAucune restriction de modification (par défaut)Documents librement modifiables
ReadOnlyCe document ne peut être modifié, seulement consulté.Documents finaux, rapports publiés
AllowCommentsSeuls les commentaires peuvent être ajoutés/modifiés.flux de travail de révision des documents
AllowFormFieldsSeuls les champs du formulaire peuvent être modifiés.Formulaires à remplir, enquêtes
AllowRevisionsSeules les modifications/révisions suivies sont autorisées.Édition collaborative avec suivi des modifications

Configuration de sécurité​

Protection par mot de passe (Ouvrir le mot de passe)​

  • ButUn mot de passe est requis pour ouvrir le document.
  • Quand l'utiliserDocuments confidentiels, informations sensibles
  • Exigence: secureOnOpenPassword doit être fourni lorsque secureOnOpen est "yes"
  • Force: 8 caractères minimum recommandés, incluant des caractères alphanumériques et spéciaux

Protection des documents (restrictions de modification)​

  • But: Limite les possibilités de modification tout en autorisant la consultation des documents
  • Quand l'utiliser: Édition collaborative, distribution de formulaires, flux de travail de révision
  • Exigence: securityOptions.protectionPassword doit être fourni lorsque securityOptions.protectionType n'est pas « NoProtection »
  • FlexibilitéPeut être combiné avec un mot de passe ouvert pour une sécurité à double couche.

Sortir​

Le PDF4me Document sécurisé REST API renvoie des réponses différentes selon le mode de traitement. API renvoie le document Word sous forme de Base64chaîne encodée dans JSON format, et non sous forme de données binaires.

Traitement synchrone (par défaut)

Le API traite la requête et renvoie :

Code d'état : 200 OK

Type de contenu : application/json

Corps de la réponse :

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

Champs de réponse :

  • document (string): Le document Word avec les paramètres de sécurité appliqués, encodé comme Base64 chaîne
  • nom de fichier (string): Le nom du fichier Word de sortie
  • succès (boolean): Indique si la requête a abouti
  • message d'erreur (string ou null) : Détails de l’erreur en cas de succès faux

Mode d'emploi :

  1. Extraire le document champ du JSON réponse (Base64)
  2. Décodez le Base64 chaîne permettant d'obtenir les données binaires d'un document Word
  3. Enregistrez ou traitez le fichier Word selon les besoins
  4. Le document nécessitera un ou plusieurs mots de passe lors de son ouverture dans Word, conformément aux paramètres de sécurité.

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

Exemple de requête​

En-tête​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Note:

  • Obtenez votre API clé de la PDF4me Tableau de bord
  • Le API La clé doit être Base64 encodé et préfixé par « Basic » dans le Authorization en-tête
  • Exemple : Si votre API La clé est abc123, encodez-le en Base64 et utiliser Authorization: Basic YWJjMTIz

Charge utile​

Exemple de base (protection par mot de passe uniquement) :

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

Exemple avancé (mot de passe + protection en lecture seule) :

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

Exemple de protection en mode commentaire uniquement :

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

Exemple de protection des champs de formulaire :

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

Exemples de code​

Le PDF4me Document sécurisé REST API propose des exemples de code dans plusieurs langages de programmation. Choisissez le langage qui convient le mieux à votre environnement de développement :

C# (CSharp) Échantillon

Complet C# Mise en œuvre pour la sécurisation des documents Word :

Cas d'utilisation et applications industrielles​

Cas d'utilisation des services juridiques et professionnels

  • Documents confidentiels des clientsProtéger par mot de passe les documents juridiques sensibles
  • Sécurité contractuelleContrats sécurisés avec protection en lecture seule pour consultation par le client
  • Distribution de formulaires juridiquesAppliquer la protection des champs de formulaire aux formulaires juridiques
  • Examen des documentsUtilisez la protection « commentaires uniquement » pour la révision des documents juridiques

Obtenez de l'aide​

Get Your API KeyAPI SamplesGetting Started