Il s'agit de la référence de l'API REST pour votre instance d'IronSecureDoc. Ce tutoriel suppose que vous avez déjà une instance du conteneur en cours d’exécution. Si vous cherchez à commencer, veuillez suivre notre guide.
Masque les mots sensibles dans un document au format PDF à l'aide d'une véritable rédaction. Incluez un fichier PDF en tant qu'objet pdf_file dans le corps de la requête.
Paramètres requis du corps de la requête
Nom
Type de données
Description
pdf_file
fichier application/pdf
Le fichier PDF à masquer.
words_to_redact
tableau[string]
Un tableau de mots à masquer dans le document.
Paramètres facultatifs du corps de la requête
Name
Data Type
Default
Description
user_password
string
null
User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password
string
null
Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages
array[int]
null
Optionally specify pages to apply to. If left empty, all pages will apply.
draw_black_box
bool
True
Have a Black Box drawn over redacted text areas.
match_whole_word
bool
True
Allow partial matches within words be redacted too.
match_case
bool
null
Match case for the words to be redacted.
overlay_text
string
null
If your prefer an Overlay Text on the redaction area such as words or symbols, set them here. If not set, a blank character will be used.
200 OK avec le fichier PDF expurgé en pièce jointe.
[POST] Réduire l'expression régulière
Point de terminaison :http://localhost:8080/v1/document-services/pdfs/redact-regular-expression
Masque les correspondances sensibles d'expressions régulières (telles que les dates, les noms ou les motifs) dans un document au format PDF en utilisant la véritable caviardage. Incluez un fichier PDF en tant qu'objet pdf_file dans le corps de la requête.
Paramètres requis du corps de la requête
Name
Data Type
Description
pdf_file
application/pdf file
The PDF file to redact.
regular_expression
string
Regular Expression from which matching cases will be redacted from the document.
200 OK avec le fichier PDF expurgé en pièce jointe.
[POST] Réduire la région
Point de terminaison :http://localhost:8080/v1/document-services/pdfs/redact-region
Description : Masque le texte sensible dans une région spécifique d'un document PDF en utilisant une vraie caviardage. Incluez un fichier PDF en tant qu'objet pdf_file dans le corps de la requête.
Paramètres requis du corps de la requête
Name
Data Type
Description
pdf_file
application/pdf file
The PDF file to redact.
region_to_redact_x
float
X coordinate of the region to redact, starting from the bottom-left of the page.
region_to_redact_y
float
Y coordinate of the region to redact, starting from the bottom-left of the page.
region_to_redact_w
float
Width of the region to redact, starting from the specified X coordinate.
region_to_redact_h
float
Height of the region to redact, starting from the specified Y coordinate.
Paramètres facultatifs du corps de la requête
Name
Data Type
Default
Description
user_password
string
null
User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password
string
null
Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages
array[int]
null
Optionally specify pages to apply to. If left empty, all pages will apply.
200 OK avec le fichier PDF expurgé en pièce jointe.
[POST] Certifier / Appliquer la signature numérique
Point de terminaison :http://localhost:8080/v1/document-services/pdfs/certify
Description : Ajoute une certification à un document PDF pour affirmer qu'il n'a pas été altéré au moyen d'un fichier de certificat (.p12, .pfx). Incluez un fichier PDF en tant qu'objet pdf_file dans le corps de la requête et un fichier de certificat en tant qu'objet certificate_file dans le corps de la requête.
Paramètres requis du corps de la requête
Nom
Type de données
Description
pdf_file
application/pdf file
The PDF file to certify.
certificate_file
application/x-pkcs12 file
The certificate file (.p12, .pfx) to use for certification.
certificate_password
string
Password for the provided certificate file.
certificate_permissions
int
certificate_permissions value
Permissions
1
No Changes Allowed. Any further document changes will invalidate the signature.
2
Only Additional Signatures and Form Filling Allowed.
3
Only AdditionalSignatures, Form Filling, and Annotations Allowed
Paramètres facultatifs du corps de la requête
Name
Data Type
Default
Description
user_password
string
null
User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password
string
null
Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
Description : Ajoute une image et une certification à cette image dans un document PDF pour attester qu'elle n'a pas été altérée au moyen d'un fichier de certificat (.p12, .pfx). Incluez un fichier PDF en tant qu'objet pdf_file dans le corps de la requête et un fichier de certificat en tant qu'objet certificate_file dans le corps de la requête.
Paramètres requis du corps de la requête
Nom
Type de données
Description
pdf_file
application/pdf file
The PDF file to certify.
signature_image_file
image/jpeg or image/png file
The signature image (.png, .jpg, .jpeg) to use for certification. Can be a logo, autograph, etc.
certificate_file
application/x-pkcs12 file
The certificate file (.p12, .pfx) to use for certification.
certificate_password
string
Password for the provided certificate file.
certificate_permissions
int
certificate_permissions value
Permissions
1
No Changes Allowed. Any further document changes will invalidate the signature.
2
Only Additional Signatures and Form Filling Allowed.
3
Only AdditionalSignatures, Form Filling, and Annotations Allowed
sign_specific_page
int
Specify page to apply the image and certificate to. First page is 0. If left empty, only first page will apply.
signature_image_x
float
The X coordinate of the Rectangle region of the signature image. This starts from the top-left of the page.
signature_image_y
float
The Y coordinate of the Rectangle region of the signature image. This starts from the top-left of the page.
signature_image_w
float
The Width of the Rectangle region of the signature image. This starts from the top-left of the page.
signature_image_h
float
The Height of the Rectangle region of the signature image. This starts from the top-left of the page.
Paramètres facultatifs du corps de la requête
Name
Data Type
Default
Description
user_password
string
null
User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password
string
null
Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages
array[int]
null
Optionally specify pages to apply to. If left empty, all pages will apply.
200 OK s'il y a des signatures et qu'elles sont toutes valides
400 Résultat BadRequest s'il n'y a pas de signatures ou si au moins une est invalide.
[POST] Chiffrer / Ajouter un mot de passe et des autorisations
Point de terminaison :http://localhost:8080/v1/document-services/pdfs/encrypt
Description: Ajoute une couche de sécurité à un document PDF en le cryptant avec un mot de passe utilisateur et propriétaire. Inclure un fichier PDF en tant qu'objet pdf_file dans le corps de la demande.
Paramètres requis du corps de la requête
Name
Data Type
Description
pdf_file
application/pdf file
The PDF file to encrypt.
allow_extracting_content
bool
Allow the extraction of content from the PDF file.
allow_form_filling
bool
Allow the filling of forms in the resulting PDF.
allow_annotations
bool
Allow the addition or modification of annotations in the resulting PDF.
allow_printing
bool
Allow printing of the resulting PDF.
allow_modifications
bool
Allow modifications to the resulting PDF.
new_owner_password
string
New owner password for the output PDF. Grants full access, including changing permissions and passwords.
Paramètres facultatifs du corps de la requête
Name
Data Type
Default
Description
user_password
string
null
User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password
string
null
Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
new_user_password
string
null
New user password for the output PDF. Grants read access and other specified permissions.
Chaknith travaille sur IronXL et IronBarcode. Il possède une expertise approfondie en C# et .NET, aidant à améliorer le logiciel et à soutenir les clients. Ses idées issues des interactions avec les utilisateurs contribuent à de meilleurs produits, une documentation améliorée et une expérience globale enrichie.
Des millions d'ingénieurs dans le monde entier lui font confiance
Réservez une démo en direct gratuite
Réservez une démonstration personnelle de 30 minutes.
Pas de contrat, pas de détails de carte, pas d'engagements.
Voici ce à quoi vous pouvez vous attendre :
Une démonstration en direct de notre produit et de ses principales fonctionnalités
Obtenez des recommandations de fonctionnalités spécifiques au projet
Toutes vos questions trouvent réponse pour vous assurer de disposer de toutes les informations dont vous avez besoin. (Aucun engagement de votre part.)
CHOISIR L'HEURE
VOS INFORMATIONS
Réservez votre démo en direct gratuite
Fiable par plus de 2 millions d'ingénieurs dans le monde entier