1. IronSecureDoc
  2. Tutoriels
  3. API REST pour IronSecureDoc

API REST pour IronSecureDoc en C

Curtis Chau
Curtis Chau
Mis à jour:
This article was translated from English: Does it need improvement?
Translated
View the article in English

Voici la documentation de 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 souhaitez commencer, veuillez suivre notre guide.

Accéder aux fonctionnalités :

Conseils

  • L'URL de remplacement http://localhost:8080/ sera utilisée dans tous les exemples. Veuillez le remplacer par votre URL.
  • Veillez à remplacer les valeurs d'espace réservé (par exemple, path/to/your/file.pdf , mot de passe du certificat , etc.) par des valeurs réelles.
  • Les en-têtes auteur , titre et sujet sont inclus dans tous les exemples de requêtes.

[GET] Vérification de l'état

Point de terminaison : http://localhost:8080/v1/document-services/ping

Point de terminaison de vérification de l'état du serveur pour s'assurer qu'il est en cours d'exécution.

Réponse : 200 OK : pong

[OBTENIR] Vérifier le permis

Point de terminaison : http://localhost:8080/v1/document-services/check-license

Vérifie la validité de la licence.

Réponse : 200 OK : Valid

[POST] Texte expurgé

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/redact-text

Masque les mots sensibles dans un document au format PDF grâce à une véritable fonction de rédaction. Incluez un fichier PDF sous forme d'objet fichier pdf dans le corps de la requête.

Paramètres obligatoires du corps de la requête

Nom Type de données Description du projet
fichier pdf application/fichier pdf Le fichier PDF à expurger.
mots_à_masquer tableau[chaîne] Liste de mots à supprimer du document.

Paramètres facultatifs du corps de la requête

Nom Type de données Défaut Description du projet
mot de passe utilisateur chaîne de caractères null Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères null Mot de passe propriétaire du fichier PDF source. Requis si le fichier PDF est protégé par un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques tableau[int] null Vous pouvez spécifier les pages auxquelles appliquer la requête. Si ce champ est laissé vide, toutes les pages seront concernées.
dessiner_boîte_noire booléen Vrai Encadrer d'un rectangle noir les zones de texte masquées.
match_whole_word booléen Vrai Autoriser également la suppression des correspondances partielles à l'intérieur des mots.
match_case booléen null Respectez la casse des mots à supprimer.
texte de superposition chaîne de caractères null Si vous souhaitez afficher un texte en surimpression sur la zone de rédaction (mots ou symboles, par exemple), indiquez-le ici. Sinon, un caractère vide sera utilisé.
enregistrer_au_pdfa booléen FAUX Enregistrez le PDF en respectant la norme PDF/A-3.
enregistrer_au_pdfua booléen FAUX Enregistrez le PDF en respectant la norme PDF/UA.

En-têtes optionnels

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

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mots_à_masquer=pdf' \
  -F 'dessiner_boîte_noire=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 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mots_à_masquer=pdf' \
  -F 'dessiner_boîte_noire=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
SHELL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mots_à_masquer=word1' \
  -F 'mots_à_masquer=word2' \
  -F 'dessiner_boîte_noire=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'texte de superposition=REDACTED' \
  -F 'pages_spécifiques=0' \
  -F 'pages_spécifiques=1' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mots_à_masquer=word1' \
  -F 'mots_à_masquer=word2' \
  -F 'dessiner_boîte_noire=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'texte de superposition=REDACTED' \
  -F 'pages_spécifiques=0' \
  -F 'pages_spécifiques=1' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
SHELL

Response:

  • 200 OK avec le fichier PDF rédigé en pièce jointe.

[POST] Supprimer une expression régulière

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/redact-regular-expression

Masque les correspondances d'expressions régulières sensibles (comme les dates, les noms ou les motifs) dans un document au format PDF en utilisant une véritable rédaction. Incluez un fichier PDF sous forme d'objet fichier pdf dans le corps de la requête.

Paramètres obligatoires du corps de la requête

Nom Type de données Description du projet
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 Défaut Description du projet
mot de passe utilisateur chaîne de caractères null Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères null Mot de passe propriétaire du fichier PDF source. Requis si le fichier PDF est protégé par un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques tableau[int] null Vous pouvez spécifier les pages auxquelles appliquer la requête. Si ce champ est laissé vide, toutes les pages seront concernées.
dessiner_boîte_noire booléen Vrai Encadrer d'un rectangle noir les zones de texte masquées.
texte de superposition chaîne de caractères null Si vous souhaitez afficher un texte en surimpression sur la zone de rédaction (mots ou symboles, par exemple), indiquez-le ici. Sinon, un caractère vide sera utilisé.
enregistrer_au_pdfa booléen FAUX Enregistrez le PDF en respectant la norme PDF/A-3.
enregistrer_au_pdfua booléen FAUX Enregistrez le PDF en respectant la norme PDF/UA.

En-têtes optionnels

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

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'expression régulière="[0-9]"' \
  -F 'dessiner_boîte_noire=true' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'expression régulière="[0-9]"' \
  -F 'dessiner_boîte_noire=true' \
SHELL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'expression régulière="[0-9]"' \
  -F 'dessiner_boîte_noire=true' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'texte de superposition=*' \
  -F 'pages_spécifiques=0' \
  -F 'pages_spécifiques=1' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'expression régulière="[0-9]"' \
  -F 'dessiner_boîte_noire=true' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'texte de superposition=*' \
  -F 'pages_spécifiques=0' \
  -F 'pages_spécifiques=1' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
SHELL

Response:

  • 200 OK avec le fichier PDF rédigé en pièce jointe.

[POST] Région de rédaction

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/redact-region

Masque les textes sensibles dans une zone spécifique d'un document PDF grâce à une véritable fonction de rédaction. Incluez un fichier PDF sous forme d'objet fichier pdf dans le corps de la requête.

Paramètres obligatoires du corps de la requête

Nom Type de données Description du projet
fichier pdf application/fichier pdf Le fichier PDF à expurger.
région_à_masquer_x float Coordonnée X de la région à masquer, en partant du coin inférieur gauche de la page.
région_à_masquer_y float Coordonnée Y de la région à masquer, en partant du coin inférieur gauche de la page.
région_à_masquer_w float Largeur de la zone à masquer, à partir de la coordonnée X spécifiée.
région_à_censurer_h float Hauteur de la zone à 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 du projet
mot de passe utilisateur chaîne de caractères null Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères null Mot de passe propriétaire du fichier PDF source. Requis si le fichier PDF est protégé par un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques tableau[int] null Vous pouvez spécifier les pages auxquelles appliquer la requête. Si ce champ est laissé vide, toutes les pages seront concernées.
dessiner_boîte_noire booléen Vrai Encadrer d'un rectangle noir les zones de texte masquées.
enregistrer_au_pdfa booléen FAUX Enregistrez le PDF en respectant la norme PDF/A-3.
enregistrer_au_pdfua booléen FAUX Enregistrez le PDF en respectant la norme PDF/UA.

En-têtes optionnels

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

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'région_à_masquer_x=100' \
  -F 'région_à_masquer_y=150' \
  -F 'région_à_masquer_w=500' \
  -F 'région_à_censurer_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'région_à_masquer_x=100' \
  -F 'région_à_masquer_y=150' \
  -F 'région_à_masquer_w=500' \
  -F 'région_à_censurer_h=400' \
SHELL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'région_à_masquer_x=100' \
  -F 'région_à_masquer_y=150' \
  -F 'région_à_masquer_w=500' \
  -F 'région_à_censurer_h=400' \
  -F 'pages_spécifiques=0' \
  -F 'pages_spécifiques=1' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'région_à_masquer_x=100' \
  -F 'région_à_masquer_y=150' \
  -F 'région_à_masquer_w=500' \
  -F 'région_à_censurer_h=400' \
  -F 'pages_spécifiques=0' \
  -F 'pages_spécifiques=1' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
SHELL

Response:

  • 200 OK avec le fichier PDF rédigé en pièce jointe.

[POST] Certifier / Appliquer une signature numérique

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/certify

Ajoute une certification à un document PDF pour attester qu'il n'a pas été falsifié au moyen d'un fichier de certificat (.p12, .pfx). Incluez un fichier PDF sous forme d'objet fichier pdf dans le corps de la requête, et un fichier de certificat sous forme d'objet fichier_certificat dans le corps de la requête.

Paramètres obligatoires du corps de la requête

Nom Type de données Description du projet
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 du fichier de certificat fourni.
autorisations de certificat int
valeur des permissions du certificat Autorisations
1 Aucune modification n'est autorisée. Toute modification ultérieure du document invalidera la signature.
2 Seules les signatures supplémentaires et le remplissage de formulaires sont autorisés.
3 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 du projet
mot de passe utilisateur chaîne de caractères null Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères null Mot de passe propriétaire du fichier PDF source. Requis si le fichier PDF est protégé par un mot de passe propriétaire pour autoriser les modifications.
enregistrer_au_pdfa booléen FAUX Enregistrez le PDF en respectant la norme PDF/A-3.
enregistrer_au_pdfua booléen FAUX Enregistrez le PDF en respectant la norme PDF/UA.

En-têtes optionnels

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

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'fichier_certificat=@sample.pfx;type=application/x-pkcs12' \
  -F 'mot de passe du certificat=p4ssw0rd' \
  -F 'autorisations de certificat=1' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'fichier_certificat=@sample.pfx;type=application/x-pkcs12' \
  -F 'mot de passe du certificat=p4ssw0rd' \
  -F 'autorisations de certificat=1' \
SHELL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'fichier_certificat=@sample.pfx;type=application/x-pkcs12' \
  -F 'mot de passe du certificat=p4ssw0rd' \
  -F 'autorisations de certificat=1' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'fichier_certificat=@sample.pfx;type=application/x-pkcs12' \
  -F 'mot de passe du certificat=p4ssw0rd' \
  -F 'autorisations de certificat=1' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
SHELL

Response:

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

[POST] Signature et certificat

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/sign

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 sous forme d'objet fichier pdf dans le corps de la requête, et un fichier de certificat sous forme d'objet fichier_certificat dans le corps de la requête.

Paramètres obligatoires du corps de la requête

Nom Type de données Description du projet
fichier pdf application/fichier pdf Le fichier PDF à certifier.
fichier_image_de_signature fichier image/jpeg ou image/png Image de signature (format .png, .jpg, .jpeg) à utiliser pour la certification. Il peut s'agir d'un logo, d'une signature, etc.
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 du fichier de certificat fourni.
autorisations de certificat int
valeur des permissions du certificat Autorisations
1 Aucune modification n'est autorisée. Toute modification ultérieure du document invalidera la signature.
2 Seules les signatures supplémentaires et le remplissage de formulaires sont autorisés.
3 Seules les signatures supplémentaires, le remplissage de formulaires et les annotations sont autorisés.

page_spécifique_signal int Indiquez la page sur laquelle appliquer l'image et le certificat. La première page est la page 0. Si ce champ est laissé vide, seule la première page sera prise en compte.
image_de_signature_x float Coordonnée X de la zone rectangulaire de l'image de la signature. Celle-ci commence en haut à gauche de la page.
image_de_signature_y float Coordonnée Y de la zone rectangulaire de l'image de la signature. Celle-ci commence en haut à gauche de la page.
image_de_signature_w float Largeur de la zone rectangulaire de l'image de signature. Cette largeur commence en haut à gauche de la page.
image_de_signature_h float Hauteur de la zone rectangulaire de l'image de signature. Cette hauteur est mesurée à 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 du projet
mot de passe utilisateur chaîne de caractères null Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères null Mot de passe propriétaire du fichier PDF source. Requis si le fichier PDF est protégé par un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques tableau[int] null Vous pouvez spécifier les pages auxquelles appliquer la requête. Si ce champ est laissé vide, toutes les pages seront concernées.
enregistrer_au_pdfa booléen FAUX Enregistrez le PDF en respectant la norme PDF/A-3.
enregistrer_au_pdfua booléen FAUX Enregistrez le PDF en respectant la norme PDF/UA.

En-têtes optionnels

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

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'fichier_image_de_signature=@autograph.png;type=image/png' \
  -F 'fichier_certificat=@sample.pfx;type=application/x-pkcs12' \
  -F 'mot de passe du certificat=p4ssw0rd' \
  -F 'autorisations de certificat=1' \
  -F 'page_spécifique_signal=0' \
  -F 'image_de_signature_x=100' \
  -F 'image_de_signature_y=150' \
  -F 'image_de_signature_w=500' \
  -F 'image_de_signature_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'fichier_image_de_signature=@autograph.png;type=image/png' \
  -F 'fichier_certificat=@sample.pfx;type=application/x-pkcs12' \
  -F 'mot de passe du certificat=p4ssw0rd' \
  -F 'autorisations de certificat=1' \
  -F 'page_spécifique_signal=0' \
  -F 'image_de_signature_x=100' \
  -F 'image_de_signature_y=150' \
  -F 'image_de_signature_w=500' \
  -F 'image_de_signature_h=400' \
SHELL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'fichier_image_de_signature=@autograph.png;type=image/png' \
  -F 'fichier_certificat=@sample.pfx;type=application/x-pkcs12' \
  -F 'mot de passe du certificat=p4ssw0rd' \
  -F 'autorisations de certificat=1' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
  -F 'page_spécifique_signal=0' \
  -F 'image_de_signature_x=100' \
  -F 'image_de_signature_y=150' \
  -F 'image_de_signature_w=500' \
  -F 'image_de_signature_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'fichier_image_de_signature=@autograph.png;type=image/png' \
  -F 'fichier_certificat=@sample.pfx;type=application/x-pkcs12' \
  -F 'mot de passe du certificat=p4ssw0rd' \
  -F 'autorisations de certificat=1' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
  -F 'page_spécifique_signal=0' \
  -F 'image_de_signature_x=100' \
  -F 'image_de_signature_y=150' \
  -F 'image_de_signature_w=500' \
  -F 'image_de_signature_h=400' \
SHELL

Response:

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

[POST] Vérifier les signatures

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/verify-signatures

Vérifie la validité des signatures contenues dans le fichier PDF.

Paramètres obligatoires du corps de la requête

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

Paramètres facultatifs du corps de la requête

Nom Type de données Défaut Description du projet
mot de passe utilisateur chaîne de caractères null Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères null Mot de passe propriétaire du fichier PDF source. Requis si le fichier PDF est protégé par un mot de passe propriétaire pour autoriser les modifications.

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@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 'fichier pdf=@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 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
YAML

Response:

  • 200 OK s'il y a des signatures et qu'elles sont toutes valides
  • 400 Mauvaise requête s'il n'y a pas de signatures ou si au moins une signature est invalide.

[POST] Chiffrer / Ajouter un mot de passe et des autorisations

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/encrypt

Ajoute une couche de sécurité à un document PDF en le chiffrant avec un mot de passe utilisateur et un mot de passe propriétaire. Incluez un fichier PDF sous forme d'objet fichier pdf dans le corps de la requête.

Paramètres obligatoires du corps de la requête

Nom Type de données Description du projet
fichier pdf application/fichier pdf Le fichier PDF à chiffrer.
autoriser_l'extraction_de_contenu booléen Autoriser l'extraction du contenu du fichier PDF.
autoriser_le_remplissage_de_formulaire booléen Autoriser le remplissage des formulaires dans le PDF généré.
autoriser_les_annotations booléen Autoriser l'ajout ou la modification d'annotations dans le PDF résultant.
autoriser_l'impression booléen Autoriser l'impression du PDF résultant.
autoriser_modifications booléen Autoriser les modifications du PDF résultant.
nouveau_mot_de_passe_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 Défaut Description du projet
mot de passe utilisateur chaîne de caractères null Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères null Mot de passe propriétaire du fichier PDF source. Requis si le fichier PDF est protégé par 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 PDF de sortie. Accorde l'accès en lecture et d'autres autorisations spécifiées.
enregistrer_au_pdfa booléen FAUX Enregistrez le PDF en respectant la norme PDF/A-3.
enregistrer_au_pdfua booléen FAUX Enregistrez le PDF en respectant la norme PDF/UA.

En-têtes optionnels

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

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'autoriser_l'extraction_de_contenu=true' \
  -F 'autoriser_le_remplissage_de_formulaire=true' \
  -F 'autoriser_les_annotations=true' \
  -F 'autoriser_l'impression=true' \
  -F 'autoriser_modifications=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'autoriser_l'extraction_de_contenu=true' \
  -F 'autoriser_le_remplissage_de_formulaire=true' \
  -F 'autoriser_les_annotations=true' \
  -F 'autoriser_l'impression=true' \
  -F 'autoriser_modifications=false' \
SHELL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'autoriser_l'extraction_de_contenu=true' \
  -F 'autoriser_le_remplissage_de_formulaire=true' \
  -F 'autoriser_les_annotations=true' \
  -F 'autoriser_l'impression=true' \
  -F 'autoriser_modifications=false' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'nouveau_mot_de_passe_utilisateur=p4ssw0rd' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'autoriser_l'extraction_de_contenu=true' \
  -F 'autoriser_le_remplissage_de_formulaire=true' \
  -F 'autoriser_les_annotations=true' \
  -F 'autoriser_l'impression=true' \
  -F 'autoriser_modifications=false' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'nouveau_mot_de_passe_utilisateur=p4ssw0rd' \
  -F 'enregistrer_au_pdfa=false' \
  -F 'enregistrer_au_pdfua=false' \
SHELL

Response:

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

[POST] Extraire du texte d'un document

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/extract

Extrait le texte intégré aux pages d'un document. Incluez un fichier PDF sous forme d'objet fichier pdf dans le corps de la requête.

Paramètres obligatoires du corps de la requête

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

Paramètres facultatifs du corps de la requête

Nom Type de données Défaut Description du projet
mot de passe utilisateur chaîne de caractères null Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères null Mot de passe propriétaire du fichier PDF source. Requis si le fichier PDF est protégé par un mot de passe propriétaire pour autoriser les modifications.
pages_spécifiques tableau[int] null Vous pouvez spécifier les pages auxquelles appliquer la requête. Si ce champ est laissé vide, toutes les pages seront concernées.

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@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 'fichier pdf=@sample.pdf;type=application/pdf' \
SHELL

Tous les paramètres obligatoires et facultatifs :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'pages_spécifiques=0' \
  -F 'pages_spécifiques=1' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
  -F 'pages_spécifiques=0' \
  -F 'pages_spécifiques=1' \
SHELL

Response:

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

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

Point de terminaison : http://localhost:8080/v1/document-services/pdfs/verify-password

Vérifie que les mots de passe utilisateur et propriétaire fournis sont valides pour le fichier pdf .

Paramètres obligatoires du corps de la requête

Nom Type de données Description du projet
fichier pdf application/fichier pdf Le fichier PDF.
mot de passe utilisateur chaîne de caractères Mot de passe utilisateur pour le fichier PDF d'entrée. Requis si le fichier PDF est protégé par un mot de passe utilisateur pour en autoriser l'accès en lecture.
mot de passe du propriétaire chaîne de caractères Mot de passe du propriétaire pour le fichier PDF d'entrée.

Exemple:

Request

Paramètres obligatoires uniquement :

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H 'auteur: Iron Software | IRONSECUREDOC' \
  -H 'titre: WEBSITE DEMO 2024' \
  -H 'sujet: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'fichier pdf=@sample.pdf;type=application/pdf' \
  -F 'mot de passe utilisateur=password' \
  -F 'mot de passe du propriétaire=5yug2RT45th32h78' \
SHELL

Response:

  • 200 OK

Questions Fréquemment Posées

Quel est l'objectif de l'API REST IronSecureDoc ?

L'API REST IronSecureDoc est conçue pour aider les développeurs à sécuriser et gérer les documents PDF en fournissant des fonctionnalités telles que l'expurgation de texte, l'application de signatures numériques, le cryptage de documents et la vérification des mots de passe.

Comment puis-je m'assurer que mon serveur est opérationnel en utilisant l'API IronSecureDoc ?

Vous pouvez vous assurer que votre serveur est opérationnel en envoyant une requête GET au point de terminaison `/v1/document-services/ping`. Si elle aboutit, le serveur répondra avec un statut `200 OK` et le message `pong`.

Comment expurger un texte ou des motifs spécifiques dans un PDF en utilisant l'API ?

Vous pouvez expurger un texte ou des motifs spécifiques dans un PDF en envoyant une requête POST au point de terminaison `/v1/document-services/pdfs/redact-text` avec le PDF et le texte ou les expressions régulières que vous souhaitez expurger.

Comment puis-je vérifier si les signatures numériques d'un PDF sont valides ?

Pour vérifier les signatures numériques dans un PDF, vous pouvez envoyer une requête POST au point de terminaison `/v1/document-services/pdfs/verify-signatures` avec le fichier PDF. L'API renverra des informations sur la validité de chaque signature.

Quelles sont les étapes pour chiffrer un PDF en utilisant l'API IronSecureDoc ?

Pour chiffrer un PDF, envoyez une requête POST au point de terminaison `/v1/document-services/pdfs/encrypt` avec le fichier PDF, en spécifiant les mots de passe utilisateur et propriétaire et toutes les autorisations que vous souhaitez définir, telles que l'extraction de contenu ou le remplissage de formulaires.

Comment puis-je signer numériquement un document PDF en utilisant l'API IronSecureDoc ?

Vous pouvez signer numériquement un PDF en envoyant une requête POST au point de terminaison `/v1/document-services/pdfs/certify` avec le fichier PDF, un certificat numérique et le mot de passe du certificat.

Quelles options sont disponibles pour protéger les documents PDF ?

Les options pour protéger les PDF incluent le chiffrement du document, la définition des autorisations d'accès, l'ajout de mots de passe utilisateur et propriétaire, et la vérification des mots de passe existants en utilisant l'API IronSecureDoc.

Est-il possible d'extraire du texte d'un PDF en utilisant l'API IronSecureDoc ?

Oui, vous pouvez extraire du texte d'un PDF en envoyant une requête POST au point de terminaison `/v1/document-services/pdfs/extract`. Vous pouvez spécifier des paramètres pour extraire le texte de certaines pages ou de l'ensemble du document.

Comment puis-je vérifier les mots de passe d'un document PDF ?

Pour vérifier les mots de passe, envoyez une requête POST au point de terminaison `/v1/document-services/pdfs/verify-password` avec le fichier PDF. Incluez à la fois les mots de passe utilisateur et propriétaire dans votre requête pour confirmer leur validité.

Quelles sont les principales capacités de l'API REST IronSecureDoc ?

Les principales capacités de l'API REST IronSecureDoc incluent les vérifications de la santé du serveur, la vérification des licences, l'expurgation de texte, l'application de signatures numériques, le cryptage de PDF et l'extraction de texte.

Curtis Chau
Curtis Chau
  Discutez maintenant avec l'équipe d'ingénierie
Rédacteur technique

Curtis Chau détient un baccalauréat en informatique (Université de Carleton) et se spécialise dans le développement front-end avec expertise en Node.js, TypeScript, JavaScript et React. Passionné par la création d'interfaces utilisateur intuitives et esthétiquement plaisantes, Curtis aime travailler avec des frameworks modernes ...

Lire la suite
Prêt à commencer?
Version: 2024.10 vient de sortir