API REST pour IronSecureDoc

Chaknith Bin

juillet 20, 2024

Mise à jour octobre 20, 2024

Translated

View the article in English

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 de conteneur en cours d'exécution, si vous cherchez àPour commencer, suivez notre guide.

Passer aux fonctionnalités :

Verify the license key
Fonctionnalité de Rédaction PDF
- Redacte le texte
- Réduire l'expression régulière
Région de Rédaction
Fonctionnalité de signature PDF
- Certifier le PDF / Appliquer une signature numérique
- Signer un PDF / Appliquer une image de signature
Check certificates / signatures
Fonctionnalité de protection des PDF
[{t :(
Le caractère générique http://localhost:8080/ sera utilisé pour l'URL dans tous les exemples. Veillez à le remplacer par votre URL.
Veillez à remplacer les valeurs de remplacement(par exemple, path/to/your/file.pdf, certificate_password, etc.) avec des valeurs réelles.
Les en-têtes author, title et subject sont inclus dans tous les exemples de requêtes.)}]

[GET] Bilan de santé

Endpoint: http://localhost:8080/v1/document-services/ping

Point d'arrivée du contrôle de santé pour vérifier que le serveur fonctionne.

Response : 200 OK : pong

[GET] Vérifier la licence

Endpoint: http://localhost:8080/v1/document-services/check-license

Vérifie la validité de la licence.

Response : 200 OK : Valid

[POST] Rédiger le texte

Endpoint: http://localhost:8080/v1/document-services/pdfs/redact-text

Masque les mots sensibles dans un document au format PDF à l'aide d'une véritable rédaction. Inclure 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 à censurer.
mots_à_censurer	tableau[string]	Un tableau de mots à censurer dans le document.

Paramètres facultatifs du corps de la requête

Nom	Type de données	Défaut	Description
mot_de_passe_utilisateur	chaîne de caractères	null	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	null	Mot de passe propriétaire pour le PDF d'entrée. Requis si le PDF possède un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques	tableau[int]	null	Optionnellement, spécifiez les pages auxquelles s'appliquer. Si laissé vide, toutes les pages s'appliqueront.
draw_black_box	bool	Vrai	Avoir une boîte noire dessinée sur les zones de texte expurgées.
correspondance_mot_entier	bool	Vrai	Permettre que les correspondances partielles au sein des mots soient également caviardées.
respecter_la_casse	bool	null	Correspondance de casse pour les mots à expurger.
texte_superposé	chaîne de caractères	null	Si vous préférez un texte superposé sur la zone de rédaction, tel que des mots ou des symboles, définissez-les ici. Si non défini, un caractère blanc sera utilisé.
enregistrer_comme_pdfa	bool	Faux	Enregistrez le PDF avec la conformité PDF/A-3.
sauvegarder_comme_pdfua	bool	Faux	Enregistrez le PDF avec la conformité PDF/UA.

En-têtes optionnels

Nom	Type de données	Description
auteur	chaîne de caractères	Définir la propriété Auteur des métadonnées du PDF.
titre	chaîne de caractères	Définir la propriété Titre des métadonnées PDF.
sujet	chaîne de caractères	Définir la propriété Sujet des métadonnées du PDF.

Exemple :

Request

Paramètres requis uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="pdf"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="pdf"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \

CURL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="word1"' \
  -F 'words_to_redact="word2"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="REDACTED"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="word1"' \
  -F 'words_to_redact="word2"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="REDACTED"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Réponse :

200 OK avec le fichier PDF expurgé en pièce jointe.

[POST] Réduire l'expression régulière

Endpoint: http://localhost:8080/v1/document-services/pdfs/redact-regular-expression

Masque les correspondances d'expressions régulières sensibles(tels que des dates, des noms ou des motifs) dans un document au format PDF en utilisant une véritable rédaction. Inclure 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 à censurer.
expression_régulière	chaîne de caractères	Expression régulière à partir de laquelle les cas correspondants seront expurgés du document.

Paramètres facultatifs du corps de la requête

Nom	Type de données	Défaut	Description
mot_de_passe_utilisateur	chaîne de caractères	null	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	null	Mot de passe propriétaire pour le PDF d'entrée. Requis si le PDF possède un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques	tableau[int]	null	Optionnellement, spécifiez les pages auxquelles s'appliquer. Si laissé vide, toutes les pages s'appliqueront.
draw_black_box	bool	Vrai	Avoir une boîte noire dessinée sur les zones de texte expurgées.
texte_superposé	chaîne de caractères	null	Si vous préférez un texte superposé sur la zone de rédaction, tel que des mots ou des symboles, définissez-les ici. Si non défini, un caractère blanc sera utilisé.
enregistrer_comme_pdfa	bool	Faux	Enregistrez le PDF avec la conformité PDF/A-3.
sauvegarder_comme_pdfua	bool	Faux	Enregistrez le PDF avec la conformité PDF/UA.

En-têtes optionnels

Nom	Type de données	Description
auteur	chaîne de caractères	Définir la propriété Auteur des métadonnées du PDF.
titre	chaîne de caractères	Définir la propriété Titre des métadonnées PDF.
sujet	chaîne de caractères	Définir la propriété Sujet des métadonnées du PDF.

Exemple :

Request

Paramètres requis uniquement :

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \

CURL

Tous les paramètres obligatoires et facultatifs :

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="%2A"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="%2A"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Réponse :

200 OK avec le fichier PDF expurgé en pièce jointe.

[POST] Réduire la région

Endpoint: 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 véritable rédaction. Inclure 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 à censurer.
région_à_rédiger_x	flotteur	Coordonnée X de la région à cacher, en partant du coin inférieur gauche de la page.
région_à_omettre_y	flotteur	Coordonnée Y de la région à expurger, en partant du coin inférieur gauche de la page.
région_à_rédiger_w	flotteur	Largeur de la région à masquer, à partir de la coordonnée X spécifiée.
region_to_redact_h	flotteur	Hauteur de la région à masquer, à partir de la coordonnée Y spécifiée.

Paramètres facultatifs du corps de la requête

Nom	Type de données	Défaut	Description
mot_de_passe_utilisateur	chaîne de caractères	null	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	null	Mot de passe propriétaire pour le PDF d'entrée. Requis si le PDF possède un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques	tableau[int]	null	Optionnellement, spécifiez les pages auxquelles s'appliquer. Si laissé vide, toutes les pages s'appliqueront.
draw_black_box	bool	Vrai	Avoir une boîte noire dessinée sur les zones de texte expurgées.
enregistrer_comme_pdfa	bool	Faux	Enregistrez le PDF avec la conformité PDF/A-3.
sauvegarder_comme_pdfua	bool	Faux	Enregistrez le PDF avec la conformité PDF/UA.

En-têtes optionnels

Nom	Type de données	Description
auteur	chaîne de caractères	Définir la propriété Auteur des métadonnées du PDF.
titre	chaîne de caractères	Définir la propriété Titre des métadonnées PDF.
sujet	chaîne de caractères	Définir la propriété Sujet des métadonnées du PDF.

Exemple :

Request

Paramètres requis uniquement :

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \

CURL

Tous les paramètres obligatoires et facultatifs :

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Réponse :

200 OK avec le fichier PDF expurgé en pièce jointe.

[POST] Certifier / Appliquer la signature numérique

Endpoint: http://localhost:8080/v1/document-services/pdfs/certify

Description : Ajoute une certification à un document PDF pour affirmer qu'il n'a pas été falsifié au moyen d'un fichier de certificat(.p12, .pfx). Inclure 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

fichier application/pdf

Le fichier PDF à certifier.

fichier_de_certificat

fichier application/x-pkcs12

Le fichier de certificat (.p12, .pfx) à utiliser pour la certification.

mot_de_passe_du_certificat

chaîne de caractères

Mot de passe pour le fichier de certificat fourni.

autorisations_de_certificat

int

valeur_certificate_permissions	Autorisations
	Aucune modification autorisée. Toute modification ultérieure du document invalidera la signature.
	Seules les signatures supplémentaires et le remplissage de formulaires sont autorisés.
	Seules les signatures supplémentaires, le remplissage de formulaires et les annotations sont autorisés.

Paramètres facultatifs du corps de la requête

Nom	Type de données	Défaut	Description
mot_de_passe_utilisateur	chaîne de caractères	null	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	null	Mot de passe propriétaire pour le PDF d'entrée. Requis si le PDF possède un mot de passe propriétaire pour autoriser les modifications.
enregistrer_comme_pdfa	bool	Faux	Enregistrez le PDF avec la conformité PDF/A-3.
sauvegarder_comme_pdfua	bool	Faux	Enregistrez le PDF avec la conformité PDF/UA.

En-têtes optionnels

Nom	Type de données	Description
auteur	chaîne de caractères	Définir la propriété Auteur des métadonnées du PDF.
titre	chaîne de caractères	Définir la propriété Titre des métadonnées PDF.
sujet	chaîne de caractères	Définir la propriété Sujet des métadonnées du PDF.

Exemple :

Request

Paramètres requis uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \

CURL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Réponse :

200 OK avec le fichier PDF certifié en pièce jointe.

[POST] Signer avec signature et certificat

Endpoint : http://localhost:8080/v1/document-services/pdfs/sign

Description : Ajoute une image et une certification à cette image dans un document PDF pour garantir qu'elle n'a pas été altérée à l'aide d'un fichier de certificat.(.p12, .pfx). Inclure 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

fichier application/pdf

Le fichier PDF à certifier.

fichier_image_signature

fichier image/jpeg ou image/png

L'image de signature (.png, .jpg, .jpeg) à utiliser pour la certification. Peut être un logo, une signature, etc.

fichier_de_certificat

fichier application/x-pkcs12

Le fichier de certificat (.p12, .pfx) à utiliser pour la certification.

mot_de_passe_du_certificat

chaîne de caractères

Mot de passe pour le fichier de certificat fourni.

autorisations_de_certificat

int

valeur_certificate_permissions	Autorisations
	Aucune modification autorisée. Toute modification ultérieure du document invalidera la signature.
	Seules les signatures supplémentaires et le remplissage de formulaires sont autorisés.
	Seules les signatures supplémentaires, le remplissage de formulaires et les annotations sont autorisés.

sign_specific_page

int

Spécifiez la page à laquelle appliquer l'image et le certificat. La première page est 0. Si elle est laissée vide, seule la première page sera appliquée.

signature_image_x

flotteur

La coordonnée X de la région Rectangle de l'image de signature. Cela commence depuis le coin supérieur gauche de la page.

signature_image_y

flotteur

La coordonnée Y de la région Rectangle de l'image de signature. Cela commence à partir du coin supérieur gauche de la page.

signature_image_w

flotteur

La largeur de la région rectangulaire de l'image de la signature. Cela commence depuis le coin supérieur gauche de la page.

signature_image_h

flotteur

La hauteur de la région du rectangle de l'image de la signature. Cela commence à partir du coin supérieur gauche de la page.

Paramètres facultatifs du corps de la requête

Nom	Type de données	Défaut	Description
mot_de_passe_utilisateur	chaîne de caractères	null	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	null	Mot de passe propriétaire pour le PDF d'entrée. Requis si le PDF possède un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques	tableau[int]	null	Optionnellement, spécifiez les pages auxquelles s'appliquer. Si laissé vide, toutes les pages s'appliqueront.
enregistrer_comme_pdfa	bool	Faux	Enregistrez le PDF avec la conformité PDF/A-3.
sauvegarder_comme_pdfua	bool	Faux	Enregistrez le PDF avec la conformité PDF/UA.

En-têtes optionnels

Nom	Type de données	Description
auteur	chaîne de caractères	Définir la propriété Auteur des métadonnées du PDF.
titre	chaîne de caractères	Définir la propriété Titre des métadonnées PDF.
sujet	chaîne de caractères	Définir la propriété Sujet des métadonnées du PDF.

Exemple :

Request

Paramètres requis uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'signature_image_file=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'signature_image_file=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

CURL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

CURL

Réponse :

200 OK avec le fichier PDF certifié en pièce jointe.

[POST] Vérifier les signatures

Point d'accès : http://localhost:8080/v1/document-services/pdfs/verify-signatures

Description : Vérifie que le mot de passe utilisateur et le mot de passe propriétaire fournis sont valides pour le pdf_file.

Paramètres requis du corps de la requête

Nom	Type de données	Description
pdf_file	fichier application/pdf	Le fichier PDF à chiffrer.

Paramètres facultatifs du corps de la requête

Nom	Type de données	Défaut	Description
mot_de_passe_utilisateur	chaîne de caractères	null	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	null	Mot de passe propriétaire pour le PDF d'entrée. Requis si le PDF possède un mot de passe propriétaire pour autoriser les modifications.

Exemple :

Request

Paramètres requis uniquement :

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

YAML

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

YAML

Réponse :

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

Endpoint: http://localhost:8080/v1/document-services/pdfs/encrypt

Description : Ajoute une couche de sécurité à un document PDF en le chiffrant à l'aide d'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

Nom	Type de données	Description
pdf_file	fichier application/pdf	Le fichier PDF à chiffrer.
autoriser_extraire_contenu	bool	Permettre l'extraction de contenu du fichier PDF.
autoriser_le_remplissage_de_formulaires	bool	Permettre le remplissage des formulaires dans le PDF résultant.
autoriser_les_annotations	bool	Permettre l'ajout ou la modification d'annotations dans le PDF résultant.
autoriser_impression	bool	Autoriser l'impression du PDF résultant.
autoriser_modifications	bool	Autoriser les modifications au PDF résultant.
nouveau_mot_de_passe_propriétaire	chaîne de caractères	Nouveau mot de passe propriétaire pour le PDF généré. Accorde un accès complet, y compris la modification des autorisations et des mots de passe.

Paramètres facultatifs du corps de la requête

Nom	Type de données	Défaut	Description
mot_de_passe_utilisateur	chaîne de caractères	null	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	null	Mot de passe propriétaire pour le PDF d'entrée. Requis si le PDF possède un mot de passe propriétaire pour autoriser les modifications.
nouveau_mot_de_passe_utilisateur	chaîne de caractères	null	Nouveau mot de passe utilisateur pour le fichier PDF de sortie. Accorde l'accès en lecture et les autres autorisations spécifiées.
enregistrer_comme_pdfa	bool	Faux	Enregistrez le PDF avec la conformité PDF/A-3.
sauvegarder_comme_pdfua	bool	Faux	Enregistrez le PDF avec la conformité PDF/UA.

En-têtes optionnels

Nom	Type de données	Description
auteur	chaîne de caractères	Définir la propriété Auteur des métadonnées du PDF.
titre	chaîne de caractères	Définir la propriété Titre des métadonnées PDF.
sujet	chaîne de caractères	Définir la propriété Sujet des métadonnées du PDF.

Exemple :

Request

Paramètres requis uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \

CURL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'new_user_password="p4ssw0rd"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'new_user_password="p4ssw0rd"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

Réponse :

200 OK avec le fichier PDF crypté en pièce jointe.

[POST] Extraire du texte d'un document

Endpoint: http://localhost:8080/v1/document-services/pdfs/extract

Description : Extrait le texte incorporé dans les pages d'un document. Inclure 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 à chiffrer.

Paramètres facultatifs du corps de la requête

Nom	Type de données	Défaut	Description
mot_de_passe_utilisateur	chaîne de caractères	null	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	null	Mot de passe propriétaire pour le PDF d'entrée. Requis si le PDF possède un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques	tableau[int]	null	Optionnellement, spécifiez les pages auxquelles s'appliquer. Si laissé vide, toutes les pages s'appliqueront.

Exemple :

Request

Paramètres requis uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

CURL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \

CURL

Réponse :

200 OK avec le texte extrait comme réponse.

[POST] Vérifier le mot de passe du document

Endpoint : http://localhost:8080/v1/document-services/pdfs/verify-password

Description : Vérifie que le mot de passe utilisateur et le mot de passe propriétaire fournis sont valides pour le pdf_file.

Paramètres requis du corps de la requête

Nom	Type de données	Description
pdf_file	fichier application/pdf	Le fichier PDF.
mot_de_passe_utilisateur	chaîne de caractères	Mot de passe utilisateur pour le PDF d'entrée. Requis si le PDF a un mot de passe utilisateur pour accorder l'accès en lecture.
owner_password	chaîne de caractères	Mot de passe propriétaire pour le PDF d'entrée.

Exemple :

Request

Paramètres requis uniquement :

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \

YAML

Réponse :

200 OK

Chaknith Bin

Discutez avec l'équipe d'ingénierie maintenant

Ingénieur logiciel

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.