1. IronSecureDoc
  2. Tutoriels
  3. Hébergement et mise en place d'Azure

API REST pour IronSecureDoc

This article was translated from English: Does it need improvement?
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.

[{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

fichier_pdf application/fichier pdf Le fichier PDF à expurger.

mots_à_détruire réseau[chaîne de caractères] Tableau de mots à supprimer du document.

Paramètres facultatifs du corps de la requête

Nom Type de données Par défaut Description

mot_de_passe chaîne de caractères nul Mot de passe de l'utilisateur pour le PDF d'entrée. Requis si le PDF dispose d'un mot de passe utilisateur pour autoriser l'accès en lecture.

mot_de_passe du propriétaire chaîne de caractères nul Mot de passe du propriétaire pour le PDF d'entrée. Requis si le PDF a un mot de passe propriétaire pour permettre l'accès aux modifications.

pages_spécifiques réseau[int] nul Vous pouvez également spécifier les pages auxquelles s'appliquer. Si ce champ est vide, toutes les pages s'appliqueront.

draw_black_box bool Vrai Faire dessiner une boîte noire sur les zones de texte expurgées.

match_whole_word bool Vrai Permettre que les correspondances partielles à l'intérieur des mots soient également expurgées.

match_case bool nul Correspondre à la casse pour les mots à expurger.

texte de recouvrement chaîne de caractères nul Si vous préférez une superposition de textes sur la zone de rédaction, tels que des mots ou des symboles, définissez-les ici. S'il n'est pas défini, un caractère blanc sera utilisé.

save_as_pdfa bool Faux Enregistrez le PDF en respectant la norme PDF/A-3.

save_as_pdfua bool Faux Enregistrez le PDF en respectant la norme 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 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 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

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

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

fichier_pdf application/fichier pdf Le fichier PDF à expurger.

expression_régulière chaîne de caractères Expression régulière à partir de laquelle les cas correspondants seront supprimés du document.

Paramètres facultatifs du corps de la requête

Nom Type de données Par défaut Description

mot_de_passe chaîne de caractères nul Mot de passe de l'utilisateur pour le PDF d'entrée. Requis si le PDF dispose d'un mot de passe utilisateur pour autoriser l'accès en lecture.

mot_de_passe du propriétaire chaîne de caractères nul Mot de passe du propriétaire pour le PDF d'entrée. Requis si le PDF a un mot de passe propriétaire pour permettre l'accès aux modifications.

pages_spécifiques réseau[int] nul Vous pouvez également spécifier les pages auxquelles s'appliquer. Si ce champ est vide, toutes les pages s'appliqueront.

draw_black_box bool Vrai Faire dessiner une boîte noire sur les zones de texte expurgées.

texte de recouvrement chaîne de caractères nul Si vous préférez une superposition de textes sur la zone de rédaction, tels que des mots ou des symboles, définissez-les ici. S'il n'est pas défini, un caractère blanc sera utilisé.

save_as_pdfa bool Faux Enregistrez le PDF en respectant la norme PDF/A-3.

save_as_pdfua bool Faux Enregistrez le PDF en respectant la norme 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 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 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

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

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

fichier_pdf application/fichier pdf Le fichier PDF à expurger.

région_à_détruire_x flotteur Coordonnée X de la région à expurger, en partant du bas gauche de la page.

region_to_redact_y flotteur Coordonnée Y de la région à expurger, en partant du bas gauche de la page.

region_to_redact_w flotteur Largeur de la région à expurger, à partir de la coordonnée X spécifiée.

region_to_redact_h flotteur Hauteur de la région à expurger, à partir de la coordonnée Y spécifiée.

Paramètres facultatifs du corps de la requête

Nom Type de données Par défaut Description

mot_de_passe chaîne de caractères nul Mot de passe de l'utilisateur pour le PDF d'entrée. Requis si le PDF dispose d'un mot de passe utilisateur pour autoriser l'accès en lecture.

mot_de_passe du propriétaire chaîne de caractères nul Mot de passe du propriétaire pour le PDF d'entrée. Requis si le PDF a un mot de passe propriétaire pour permettre l'accès aux modifications.

pages_spécifiques réseau[int] nul Vous pouvez également spécifier les pages auxquelles s'appliquer. Si ce champ est vide, toutes les pages s'appliqueront.

draw_black_box bool Vrai Faire dessiner une boîte noire sur les zones de texte expurgées.

save_as_pdfa bool Faux Enregistrez le PDF en respectant la norme PDF/A-3.

save_as_pdfua bool Faux Enregistrez le PDF en respectant la norme 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 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 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

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

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

fichier_pdf application/fichier pdf Le fichier PDF à certifier.

fichier_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.

certificat_permissions int Type d'autorisation pour la certification : 0 : Défaut, 1 : FormFillingAllowed, 2 : FormFillingAndAnnotationsAllowed, 3 : NoChangesAllowed

Paramètres facultatifs du corps de la requête

Nom Type de données Par défaut Description

mot_de_passe chaîne de caractères nul Mot de passe de l'utilisateur pour le PDF d'entrée. Requis si le PDF dispose d'un mot de passe utilisateur pour autoriser l'accès en lecture.

mot_de_passe du propriétaire chaîne de caractères nul Mot de passe du propriétaire pour le PDF d'entrée. Requis si le PDF a un mot de passe propriétaire pour permettre l'accès aux modifications.

pages_spécifiques réseau[int] nul Vous pouvez également spécifier les pages auxquelles s'appliquer. Si ce champ est vide, toutes les pages s'appliqueront.

save_as_pdfa bool Faux Enregistrez le PDF en respectant la norme PDF/A-3.

save_as_pdfua bool Faux Enregistrez le PDF en respectant la norme 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 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 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=0' \
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=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -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 certifié en pièce jointe.

[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

fichier_pdf application/fichier pdf Le fichier PDF à crypter.

autoriser l'extraction de contenu bool Permettre l'extraction du contenu du fichier PDF.

allow_form_filling bool Permet de remplir 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 l'impression bool Autoriser l'impression du PDF résultant.

autoriser_modifications bool Autoriser la modification du PDF résultant.

nouveau_mot_de_passe du propriétaire chaîne de caractères Nouveau mot de passe propriétaire pour le PDF de sortie. 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 Par défaut Description

mot_de_passe chaîne de caractères nul Mot de passe de l'utilisateur pour le PDF d'entrée. Requis si le PDF dispose d'un mot de passe utilisateur pour autoriser l'accès en lecture.

mot_de_passe du propriétaire chaîne de caractères nul Mot de passe du propriétaire pour le PDF d'entrée. Requis si le PDF a un mot de passe propriétaire pour permettre l'accès aux modifications.

nouveau_mot_de_passe chaîne de caractères nul Nouveau mot de passe utilisateur pour le PDF de sortie. Accorde l'accès en lecture et d'autres autorisations spécifiées.

save_as_pdfa bool Faux Enregistrez le PDF en respectant la norme PDF/A-3.

save_as_pdfua bool Faux Enregistrez le PDF en respectant la norme 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 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 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

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

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

fichier_pdf application/fichier pdf Le fichier PDF à crypter.

Paramètres facultatifs du corps de la requête

Nom Type de données Par défaut Description

mot_de_passe chaîne de caractères nul Mot de passe de l'utilisateur pour le PDF d'entrée. Requis si le PDF dispose d'un mot de passe utilisateur pour autoriser l'accès en lecture.

mot_de_passe du propriétaire chaîne de caractères nul Mot de passe du propriétaire pour le PDF d'entrée. Requis si le PDF a un mot de passe propriétaire pour permettre l'accès aux modifications.

pages_spécifiques réseau[int] nul Vous pouvez également spécifier les pages auxquelles s'appliquer. Si ce champ est 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

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

Réponse :

  • 200 OK avec le texte extrait comme réponse.